mirror of
https://github.com/Relintai/pandemonium_engine_docs.git
synced 2025-01-23 15:17:21 +01:00
5318 lines
747 KiB
ReStructuredText
5318 lines
747 KiB
ReStructuredText
|
:github_url: hide
|
|||
|
|
|
|||
|
|
.. DO NOT EDIT THIS FILE!!!
|
|||
|
|
.. Generated automatically from Godot engine sources.
|
|||
|
|
.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py.
|
|||
|
|
.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/VisualServer.xml.
|
|||
|
|
|
|||
|
|
.. _class_VisualServer:
|
|||
|
|
|
|||
|
|
VisualServer
|
|||
|
|
============
|
|||
|
|
|
|||
|
|
**Inherits:** :ref:`Object<class_Object>`
|
|||
|
|
|
|||
|
|
Server for anything visible.
|
|||
|
|
|
|||
|
|
Description
|
|||
|
|
-----------
|
|||
|
|
|
|||
|
|
Server for anything visible. The visual server is the API backend for everything visible. The whole scene system mounts on it to display.
|
|||
|
|
|
|||
|
|
The visual server is completely opaque, the internals are entirely implementation specific and cannot be accessed.
|
|||
|
|
|
|||
|
|
The visual server can be used to bypass the scene system entirely.
|
|||
|
|
|
|||
|
|
Resources are created using the ``*_create`` functions.
|
|||
|
|
|
|||
|
|
All objects are drawn to a viewport. You can use the :ref:`Viewport<class_Viewport>` attached to the :ref:`SceneTree<class_SceneTree>` or you can create one yourself with :ref:`viewport_create<class_VisualServer_method_viewport_create>`. When using a custom scenario or canvas, the scenario or canvas needs to be attached to the viewport using :ref:`viewport_set_scenario<class_VisualServer_method_viewport_set_scenario>` or :ref:`viewport_attach_canvas<class_VisualServer_method_viewport_attach_canvas>`.
|
|||
|
|
|
|||
|
|
In 3D, all visual objects must be associated with a scenario. The scenario is a visual representation of the world. If accessing the visual server from a running game, the scenario can be accessed from the scene tree from any :ref:`Spatial<class_Spatial>` node with :ref:`Spatial.get_world<class_Spatial_method_get_world>`. Otherwise, a scenario can be created with :ref:`scenario_create<class_VisualServer_method_scenario_create>`.
|
|||
|
|
|
|||
|
|
Similarly, in 2D, a canvas is needed to draw all canvas items.
|
|||
|
|
|
|||
|
|
In 3D, all visible objects are comprised of a resource and an instance. A resource can be a mesh, a particle system, a light, or any other 3D object. In order to be visible resources must be attached to an instance using :ref:`instance_set_base<class_VisualServer_method_instance_set_base>`. The instance must also be attached to the scenario using :ref:`instance_set_scenario<class_VisualServer_method_instance_set_scenario>` in order to be visible.
|
|||
|
|
|
|||
|
|
In 2D, all visible objects are some form of canvas item. In order to be visible, a canvas item needs to be the child of a canvas attached to a viewport, or it needs to be the child of another canvas item that is eventually attached to the canvas.
|
|||
|
|
|
|||
|
|
Tutorials
|
|||
|
|
---------
|
|||
|
|
|
|||
|
|
- :doc:`../tutorials/performance/using_servers`
|
|||
|
|
|
|||
|
|
Properties
|
|||
|
|
----------
|
|||
|
|
|
|||
|
|
+-------------------------+-----------------------------------------------------------------------------+
|
|||
|
|
| :ref:`bool<class_bool>` | :ref:`render_loop_enabled<class_VisualServer_property_render_loop_enabled>` |
|
|||
|
|
+-------------------------+-----------------------------------------------------------------------------+
|
|||
|
|
|
|||
|
|
Methods
|
|||
|
|
-------
|
|||
|
|
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`black_bars_set_images<class_VisualServer_method_black_bars_set_images>` **(** :ref:`RID<class_RID>` left, :ref:`RID<class_RID>` top, :ref:`RID<class_RID>` right, :ref:`RID<class_RID>` bottom **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`black_bars_set_margins<class_VisualServer_method_black_bars_set_margins>` **(** :ref:`int<class_int>` left, :ref:`int<class_int>` top, :ref:`int<class_int>` right, :ref:`int<class_int>` bottom **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| :ref:`RID<class_RID>` | :ref:`camera_create<class_VisualServer_method_camera_create>` **(** **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`camera_reset_physics_interpolation<class_VisualServer_method_camera_reset_physics_interpolation>` **(** :ref:`RID<class_RID>` camera **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`camera_set_cull_mask<class_VisualServer_method_camera_set_cull_mask>` **(** :ref:`RID<class_RID>` camera, :ref:`int<class_int>` layers **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`camera_set_environment<class_VisualServer_method_camera_set_environment>` **(** :ref:`RID<class_RID>` camera, :ref:`RID<class_RID>` env **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`camera_set_frustum<class_VisualServer_method_camera_set_frustum>` **(** :ref:`RID<class_RID>` camera, :ref:`float<class_float>` size, :ref:`Vector2<class_Vector2>` offset, :ref:`float<class_float>` z_near, :ref:`float<class_float>` z_far **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`camera_set_interpolated<class_VisualServer_method_camera_set_interpolated>` **(** :ref:`RID<class_RID>` camera, :ref:`bool<class_bool>` interpolated **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`camera_set_orthogonal<class_VisualServer_method_camera_set_orthogonal>` **(** :ref:`RID<class_RID>` camera, :ref:`float<class_float>` size, :ref:`float<class_float>` z_near, :ref:`float<class_float>` z_far **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`camera_set_perspective<class_VisualServer_method_camera_set_perspective>` **(** :ref:`RID<class_RID>` camera, :ref:`float<class_float>` fovy_degrees, :ref:`float<class_float>` z_near, :ref:`float<class_float>` z_far **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`camera_set_transform<class_VisualServer_method_camera_set_transform>` **(** :ref:`RID<class_RID>` camera, :ref:`Transform<class_Transform>` transform **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`camera_set_use_vertical_aspect<class_VisualServer_method_camera_set_use_vertical_aspect>` **(** :ref:`RID<class_RID>` camera, :ref:`bool<class_bool>` enable **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| :ref:`RID<class_RID>` | :ref:`canvas_create<class_VisualServer_method_canvas_create>` **(** **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`canvas_item_add_circle<class_VisualServer_method_canvas_item_add_circle>` **(** :ref:`RID<class_RID>` item, :ref:`Vector2<class_Vector2>` pos, :ref:`float<class_float>` radius, :ref:`Color<class_Color>` color **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`canvas_item_add_clip_ignore<class_VisualServer_method_canvas_item_add_clip_ignore>` **(** :ref:`RID<class_RID>` item, :ref:`bool<class_bool>` ignore **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`canvas_item_add_line<class_VisualServer_method_canvas_item_add_line>` **(** :ref:`RID<class_RID>` item, :ref:`Vector2<class_Vector2>` from, :ref:`Vector2<class_Vector2>` to, :ref:`Color<class_Color>` color, :ref:`float<class_float>` width=1.0, :ref:`bool<class_bool>` antialiased=false **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`canvas_item_add_mesh<class_VisualServer_method_canvas_item_add_mesh>` **(** :ref:`RID<class_RID>` item, :ref:`RID<class_RID>` mesh, :ref:`Transform2D<class_Transform2D>` transform=Transform2D( 1, 0, 0, 1, 0, 0 ), :ref:`Color<class_Color>` modulate=Color( 1, 1, 1, 1 ), :ref:`RID<class_RID>` texture, :ref:`RID<class_RID>` normal_map **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`canvas_item_add_multimesh<class_VisualServer_method_canvas_item_add_multimesh>` **(** :ref:`RID<class_RID>` item, :ref:`RID<class_RID>` mesh, :ref:`RID<class_RID>` texture, :ref:`RID<class_RID>` normal_map **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`canvas_item_add_nine_patch<class_VisualServer_method_canvas_item_add_nine_patch>` **(** :ref:`RID<class_RID>` item, :ref:`Rect2<class_Rect2>` rect, :ref:`Rect2<class_Rect2>` source, :ref:`RID<class_RID>` texture, :ref:`Vector2<class_Vector2>` topleft, :ref:`Vector2<class_Vector2>` bottomright, :ref:`NinePatchAxisMode<enum_VisualServer_NinePatchAxisMode>` x_axis_mode=0, :ref:`NinePatchAxisMode<enum_VisualServer_NinePatchAxisMode>` y_axis_mode=0, :ref:`bool<class_bool>` draw_center=true, :ref:`Color<class_Color>` modulate=Color( 1, 1, 1, 1 ), :ref:`RID<class_RID>` normal_map **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`canvas_item_add_particles<class_VisualServer_method_canvas_item_add_particles>` **(** :ref:`RID<class_RID>` item, :ref:`RID<class_RID>` particles, :ref:`RID<class_RID>` texture, :ref:`RID<class_RID>` normal_map **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`canvas_item_add_polygon<class_VisualServer_method_canvas_item_add_polygon>` **(** :ref:`RID<class_RID>` item, :ref:`PoolVector2Array<class_PoolVector2Array>` points, :ref:`PoolColorArray<class_PoolColorArray>` colors, :ref:`PoolVector2Array<class_PoolVector2Array>` uvs=PoolVector2Array( ), :ref:`RID<class_RID>` texture, :ref:`RID<class_RID>` normal_map, :ref:`bool<class_bool>` antialiased=false **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`canvas_item_add_polyline<class_VisualServer_method_canvas_item_add_polyline>` **(** :ref:`RID<class_RID>` item, :ref:`PoolVector2Array<class_PoolVector2Array>` points, :ref:`PoolColorArray<class_PoolColorArray>` colors, :ref:`float<class_float>` width=1.0, :ref:`bool<class_bool>` antialiased=false **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`canvas_item_add_primitive<class_VisualServer_method_canvas_item_add_primitive>` **(** :ref:`RID<class_RID>` item, :ref:`PoolVector2Array<class_PoolVector2Array>` points, :ref:`PoolColorArray<class_PoolColorArray>` colors, :ref:`PoolVector2Array<class_PoolVector2Array>` uvs, :ref:`RID<class_RID>` texture, :ref:`float<class_float>` width=1.0, :ref:`RID<class_RID>` normal_map **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`canvas_item_add_rect<class_VisualServer_method_canvas_item_add_rect>` **(** :ref:`RID<class_RID>` item, :ref:`Rect2<class_Rect2>` rect, :ref:`Color<class_Color>` color **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`canvas_item_add_set_transform<class_VisualServer_method_canvas_item_add_set_transform>` **(** :ref:`RID<class_RID>` item, :ref:`Transform2D<class_Transform2D>` transform **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`canvas_item_add_texture_rect<class_VisualServer_method_canvas_item_add_texture_rect>` **(** :ref:`RID<class_RID>` item, :ref:`Rect2<class_Rect2>` rect, :ref:`RID<class_RID>` texture, :ref:`bool<class_bool>` tile=false, :ref:`Color<class_Color>` modulate=Color( 1, 1, 1, 1 ), :ref:`bool<class_bool>` transpose=false, :ref:`RID<class_RID>` normal_map **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`canvas_item_add_texture_rect_region<class_VisualServer_method_canvas_item_add_texture_rect_region>` **(** :ref:`RID<class_RID>` item, :ref:`Rect2<class_Rect2>` rect, :ref:`RID<class_RID>` texture, :ref:`Rect2<class_Rect2>` src_rect, :ref:`Color<class_Color>` modulate=Color( 1, 1, 1, 1 ), :ref:`bool<class_bool>` transpose=false, :ref:`RID<class_RID>` normal_map, :ref:`bool<class_bool>` clip_uv=true **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`canvas_item_add_triangle_array<class_VisualServer_method_canvas_item_add_triangle_array>` **(** :ref:`RID<class_RID>` item, :ref:`PoolIntArray<class_PoolIntArray>` indices, :ref:`PoolVector2Array<class_PoolVector2Array>` points, :ref:`PoolColorArray<class_PoolColorArray>` colors, :ref:`PoolVector2Array<class_PoolVector2Array>` uvs=PoolVector2Array( ), :ref:`PoolIntArray<class_PoolIntArray>` bones=PoolIntArray( ), :ref:`PoolRealArray<class_PoolRealArray>` weights=PoolRealArray( ), :ref:`RID<class_RID>` texture, :ref:`int<class_int>` count=-1, :ref:`RID<class_RID>` normal_map, :ref:`bool<class_bool>` antialiased=false, :ref:`bool<class_bool>` antialiasing_use_indices=false **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`canvas_item_clear<class_VisualServer_method_canvas_item_clear>` **(** :ref:`RID<class_RID>` item **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| :ref:`RID<class_RID>` | :ref:`canvas_item_create<class_VisualServer_method_canvas_item_create>` **(** **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`canvas_item_set_clip<class_VisualServer_method_canvas_item_set_clip>` **(** :ref:`RID<class_RID>` item, :ref:`bool<class_bool>` clip **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`canvas_item_set_copy_to_backbuffer<class_VisualServer_method_canvas_item_set_copy_to_backbuffer>` **(** :ref:`RID<class_RID>` item, :ref:`bool<class_bool>` enabled, :ref:`Rect2<class_Rect2>` rect **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`canvas_item_set_custom_rect<class_VisualServer_method_canvas_item_set_custom_rect>` **(** :ref:`RID<class_RID>` item, :ref:`bool<class_bool>` use_custom_rect, :ref:`Rect2<class_Rect2>` rect=Rect2( 0, 0, 0, 0 ) **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`canvas_item_set_distance_field_mode<class_VisualServer_method_canvas_item_set_distance_field_mode>` **(** :ref:`RID<class_RID>` item, :ref:`bool<class_bool>` enabled **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`canvas_item_set_draw_behind_parent<class_VisualServer_method_canvas_item_set_draw_behind_parent>` **(** :ref:`RID<class_RID>` item, :ref:`bool<class_bool>` enabled **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`canvas_item_set_draw_index<class_VisualServer_method_canvas_item_set_draw_index>` **(** :ref:`RID<class_RID>` item, :ref:`int<class_int>` index **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`canvas_item_set_light_mask<class_VisualServer_method_canvas_item_set_light_mask>` **(** :ref:`RID<class_RID>` item, :ref:`int<class_int>` mask **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`canvas_item_set_material<class_VisualServer_method_canvas_item_set_material>` **(** :ref:`RID<class_RID>` item, :ref:`RID<class_RID>` material **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`canvas_item_set_modulate<class_VisualServer_method_canvas_item_set_modulate>` **(** :ref:`RID<class_RID>` item, :ref:`Color<class_Color>` color **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`canvas_item_set_parent<class_VisualServer_method_canvas_item_set_parent>` **(** :ref:`RID<class_RID>` item, :ref:`RID<class_RID>` parent **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`canvas_item_set_self_modulate<class_VisualServer_method_canvas_item_set_self_modulate>` **(** :ref:`RID<class_RID>` item, :ref:`Color<class_Color>` color **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`canvas_item_set_sort_children_by_y<class_VisualServer_method_canvas_item_set_sort_children_by_y>` **(** :ref:`RID<class_RID>` item, :ref:`bool<class_bool>` enabled **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`canvas_item_set_transform<class_VisualServer_method_canvas_item_set_transform>` **(** :ref:`RID<class_RID>` item, :ref:`Transform2D<class_Transform2D>` transform **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`canvas_item_set_use_parent_material<class_VisualServer_method_canvas_item_set_use_parent_material>` **(** :ref:`RID<class_RID>` item, :ref:`bool<class_bool>` enabled **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`canvas_item_set_visible<class_VisualServer_method_canvas_item_set_visible>` **(** :ref:`RID<class_RID>` item, :ref:`bool<class_bool>` visible **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`canvas_item_set_z_as_relative_to_parent<class_VisualServer_method_canvas_item_set_z_as_relative_to_parent>` **(** :ref:`RID<class_RID>` item, :ref:`bool<class_bool>` enabled **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`canvas_item_set_z_index<class_VisualServer_method_canvas_item_set_z_index>` **(** :ref:`RID<class_RID>` item, :ref:`int<class_int>` z_index **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`canvas_light_attach_to_canvas<class_VisualServer_method_canvas_light_attach_to_canvas>` **(** :ref:`RID<class_RID>` light, :ref:`RID<class_RID>` canvas **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| :ref:`RID<class_RID>` | :ref:`canvas_light_create<class_VisualServer_method_canvas_light_create>` **(** **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`canvas_light_occluder_attach_to_canvas<class_VisualServer_method_canvas_light_occluder_attach_to_canvas>` **(** :ref:`RID<class_RID>` occluder, :ref:`RID<class_RID>` canvas **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| :ref:`RID<class_RID>` | :ref:`canvas_light_occluder_create<class_VisualServer_method_canvas_light_occluder_create>` **(** **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`canvas_light_occluder_set_enabled<class_VisualServer_method_canvas_light_occluder_set_enabled>` **(** :ref:`RID<class_RID>` occluder, :ref:`bool<class_bool>` enabled **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`canvas_light_occluder_set_light_mask<class_VisualServer_method_canvas_light_occluder_set_light_mask>` **(** :ref:`RID<class_RID>` occluder, :ref:`int<class_int>` mask **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`canvas_light_occluder_set_polygon<class_VisualServer_method_canvas_light_occluder_set_polygon>` **(** :ref:`RID<class_RID>` occluder, :ref:`RID<class_RID>` polygon **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`canvas_light_occluder_set_transform<class_VisualServer_method_canvas_light_occluder_set_transform>` **(** :ref:`RID<class_RID>` occluder, :ref:`Transform2D<class_Transform2D>` transform **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`canvas_light_set_color<class_VisualServer_method_canvas_light_set_color>` **(** :ref:`RID<class_RID>` light, :ref:`Color<class_Color>` color **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`canvas_light_set_enabled<class_VisualServer_method_canvas_light_set_enabled>` **(** :ref:`RID<class_RID>` light, :ref:`bool<class_bool>` enabled **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`canvas_light_set_energy<class_VisualServer_method_canvas_light_set_energy>` **(** :ref:`RID<class_RID>` light, :ref:`float<class_float>` energy **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`canvas_light_set_height<class_VisualServer_method_canvas_light_set_height>` **(** :ref:`RID<class_RID>` light, :ref:`float<class_float>` height **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`canvas_light_set_item_cull_mask<class_VisualServer_method_canvas_light_set_item_cull_mask>` **(** :ref:`RID<class_RID>` light, :ref:`int<class_int>` mask **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`canvas_light_set_item_shadow_cull_mask<class_VisualServer_method_canvas_light_set_item_shadow_cull_mask>` **(** :ref:`RID<class_RID>` light, :ref:`int<class_int>` mask **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`canvas_light_set_layer_range<class_VisualServer_method_canvas_light_set_layer_range>` **(** :ref:`RID<class_RID>` light, :ref:`int<class_int>` min_layer, :ref:`int<class_int>` max_layer **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`canvas_light_set_mode<class_VisualServer_method_canvas_light_set_mode>` **(** :ref:`RID<class_RID>` light, :ref:`CanvasLightMode<enum_VisualServer_CanvasLightMode>` mode **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`canvas_light_set_scale<class_VisualServer_method_canvas_light_set_scale>` **(** :ref:`RID<class_RID>` light, :ref:`float<class_float>` scale **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`canvas_light_set_shadow_buffer_size<class_VisualServer_method_canvas_light_set_shadow_buffer_size>` **(** :ref:`RID<class_RID>` light, :ref:`int<class_int>` size **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`canvas_light_set_shadow_color<class_VisualServer_method_canvas_light_set_shadow_color>` **(** :ref:`RID<class_RID>` light, :ref:`Color<class_Color>` color **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`canvas_light_set_shadow_enabled<class_VisualServer_method_canvas_light_set_shadow_enabled>` **(** :ref:`RID<class_RID>` light, :ref:`bool<class_bool>` enabled **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`canvas_light_set_shadow_filter<class_VisualServer_method_canvas_light_set_shadow_filter>` **(** :ref:`RID<class_RID>` light, :ref:`CanvasLightShadowFilter<enum_VisualServer_CanvasLightShadowFilter>` filter **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`canvas_light_set_shadow_gradient_length<class_VisualServer_method_canvas_light_set_shadow_gradient_length>` **(** :ref:`RID<class_RID>` light, :ref:`float<class_float>` length **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`canvas_light_set_shadow_smooth<class_VisualServer_method_canvas_light_set_shadow_smooth>` **(** :ref:`RID<class_RID>` light, :ref:`float<class_float>` smooth **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`canvas_light_set_texture<class_VisualServer_method_canvas_light_set_texture>` **(** :ref:`RID<class_RID>` light, :ref:`RID<class_RID>` texture **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`canvas_light_set_texture_offset<class_VisualServer_method_canvas_light_set_texture_offset>` **(** :ref:`RID<class_RID>` light, :ref:`Vector2<class_Vector2>` offset **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`canvas_light_set_transform<class_VisualServer_method_canvas_light_set_transform>` **(** :ref:`RID<class_RID>` light, :ref:`Transform2D<class_Transform2D>` transform **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`canvas_light_set_z_range<class_VisualServer_method_canvas_light_set_z_range>` **(** :ref:`RID<class_RID>` light, :ref:`int<class_int>` min_z, :ref:`int<class_int>` max_z **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| :ref:`RID<class_RID>` | :ref:`canvas_occluder_polygon_create<class_VisualServer_method_canvas_occluder_polygon_create>` **(** **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`canvas_occluder_polygon_set_cull_mode<class_VisualServer_method_canvas_occluder_polygon_set_cull_mode>` **(** :ref:`RID<class_RID>` occluder_polygon, :ref:`CanvasOccluderPolygonCullMode<enum_VisualServer_CanvasOccluderPolygonCullMode>` mode **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`canvas_occluder_polygon_set_shape<class_VisualServer_method_canvas_occluder_polygon_set_shape>` **(** :ref:`RID<class_RID>` occluder_polygon, :ref:`PoolVector2Array<class_PoolVector2Array>` shape, :ref:`bool<class_bool>` closed **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`canvas_occluder_polygon_set_shape_as_lines<class_VisualServer_method_canvas_occluder_polygon_set_shape_as_lines>` **(** :ref:`RID<class_RID>` occluder_polygon, :ref:`PoolVector2Array<class_PoolVector2Array>` shape **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`canvas_set_item_mirroring<class_VisualServer_method_canvas_set_item_mirroring>` **(** :ref:`RID<class_RID>` canvas, :ref:`RID<class_RID>` item, :ref:`Vector2<class_Vector2>` mirroring **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`canvas_set_modulate<class_VisualServer_method_canvas_set_modulate>` **(** :ref:`RID<class_RID>` canvas, :ref:`Color<class_Color>` color **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| :ref:`RID<class_RID>` | :ref:`directional_light_create<class_VisualServer_method_directional_light_create>` **(** **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`draw<class_VisualServer_method_draw>` **(** :ref:`bool<class_bool>` swap_buffers=true, :ref:`float<class_float>` frame_step=0.0 **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| :ref:`RID<class_RID>` | :ref:`environment_create<class_VisualServer_method_environment_create>` **(** **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`environment_set_adjustment<class_VisualServer_method_environment_set_adjustment>` **(** :ref:`RID<class_RID>` env, :ref:`bool<class_bool>` enable, :ref:`float<class_float>` brightness, :ref:`float<class_float>` contrast, :ref:`float<class_float>` saturation, :ref:`RID<class_RID>` ramp **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`environment_set_ambient_light<class_VisualServer_method_environment_set_ambient_light>` **(** :ref:`RID<class_RID>` env, :ref:`Color<class_Color>` color, :ref:`float<class_float>` energy=1.0, :ref:`float<class_float>` sky_contibution=0.0 **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`environment_set_background<class_VisualServer_method_environment_set_background>` **(** :ref:`RID<class_RID>` env, :ref:`EnvironmentBG<enum_VisualServer_EnvironmentBG>` bg **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`environment_set_bg_color<class_VisualServer_method_environment_set_bg_color>` **(** :ref:`RID<class_RID>` env, :ref:`Color<class_Color>` color **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`environment_set_bg_energy<class_VisualServer_method_environment_set_bg_energy>` **(** :ref:`RID<class_RID>` env, :ref:`float<class_float>` energy **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`environment_set_canvas_max_layer<class_VisualServer_method_environment_set_canvas_max_layer>` **(** :ref:`RID<class_RID>` env, :ref:`int<class_int>` max_layer **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`environment_set_dof_blur_far<class_VisualServer_method_environment_set_dof_blur_far>` **(** :ref:`RID<class_RID>` env, :ref:`bool<class_bool>` enable, :ref:`float<class_float>` distance, :ref:`float<class_float>` transition, :ref:`float<class_float>` far_amount, :ref:`EnvironmentDOFBlurQuality<enum_VisualServer_EnvironmentDOFBlurQuality>` quality **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`environment_set_dof_blur_near<class_VisualServer_method_environment_set_dof_blur_near>` **(** :ref:`RID<class_RID>` env, :ref:`bool<class_bool>` enable, :ref:`float<class_float>` distance, :ref:`float<class_float>` transition, :ref:`float<class_float>` far_amount, :ref:`EnvironmentDOFBlurQuality<enum_VisualServer_EnvironmentDOFBlurQuality>` quality **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`environment_set_fog<class_VisualServer_method_environment_set_fog>` **(** :ref:`RID<class_RID>` env, :ref:`bool<class_bool>` enable, :ref:`Color<class_Color>` color, :ref:`Color<class_Color>` sun_color, :ref:`float<class_float>` sun_amount **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`environment_set_fog_depth<class_VisualServer_method_environment_set_fog_depth>` **(** :ref:`RID<class_RID>` env, :ref:`bool<class_bool>` enable, :ref:`float<class_float>` depth_begin, :ref:`float<class_float>` depth_end, :ref:`float<class_float>` depth_curve, :ref:`bool<class_bool>` transmit, :ref:`float<class_float>` transmit_curve **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`environment_set_fog_height<class_VisualServer_method_environment_set_fog_height>` **(** :ref:`RID<class_RID>` env, :ref:`bool<class_bool>` enable, :ref:`float<class_float>` min_height, :ref:`float<class_float>` max_height, :ref:`float<class_float>` height_curve **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`environment_set_glow<class_VisualServer_method_environment_set_glow>` **(** :ref:`RID<class_RID>` env, :ref:`bool<class_bool>` enable, :ref:`int<class_int>` level_flags, :ref:`float<class_float>` intensity, :ref:`float<class_float>` strength, :ref:`float<class_float>` bloom_threshold, :ref:`EnvironmentGlowBlendMode<enum_VisualServer_EnvironmentGlowBlendMode>` blend_mode, :ref:`float<class_float>` hdr_bleed_threshold, :ref:`float<class_float>` hdr_bleed_scale, :ref:`float<class_float>` hdr_luminance_cap, :ref:`bool<class_bool>` bicubic_upscale, :ref:`bool<class_bool>` high_quality **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`environment_set_sky<class_VisualServer_method_environment_set_sky>` **(** :ref:`RID<class_RID>` env, :ref:`RID<class_RID>` sky **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`environment_set_sky_custom_fov<class_VisualServer_method_environment_set_sky_custom_fov>` **(** :ref:`RID<class_RID>` env, :ref:`float<class_float>` scale **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`environment_set_sky_orientation<class_VisualServer_method_environment_set_sky_orientation>` **(** :ref:`RID<class_RID>` env, :ref:`Basis<class_Basis>` orientation **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`environment_set_ssao<class_VisualServer_method_environment_set_ssao>` **(** :ref:`RID<class_RID>` env, :ref:`bool<class_bool>` enable, :ref:`float<class_float>` radius, :ref:`float<class_float>` intensity, :ref:`float<class_float>` radius2, :ref:`float<class_float>` intensity2, :ref:`float<class_float>` bias, :ref:`float<class_float>` light_affect, :ref:`float<class_float>` ao_channel_affect, :ref:`Color<class_Color>` color, :ref:`EnvironmentSSAOQuality<enum_VisualServer_EnvironmentSSAOQuality>` quality, :ref:`EnvironmentSSAOBlur<enum_VisualServer_EnvironmentSSAOBlur>` blur, :ref:`float<class_float>` bilateral_sharpness **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`environment_set_ssr<class_VisualServer_method_environment_set_ssr>` **(** :ref:`RID<class_RID>` env, :ref:`bool<class_bool>` enable, :ref:`int<class_int>` max_steps, :ref:`float<class_float>` fade_in, :ref:`float<class_float>` fade_out, :ref:`float<class_float>` depth_tolerance, :ref:`bool<class_bool>` roughness **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`environment_set_tonemap<class_VisualServer_method_environment_set_tonemap>` **(** :ref:`RID<class_RID>` env, :ref:`EnvironmentToneMapper<enum_VisualServer_EnvironmentToneMapper>` tone_mapper, :ref:`float<class_float>` exposure, :ref:`float<class_float>` white, :ref:`bool<class_bool>` auto_exposure, :ref:`float<class_float>` min_luminance, :ref:`float<class_float>` max_luminance, :ref:`float<class_float>` auto_exp_speed, :ref:`float<class_float>` auto_exp_grey **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`finish<class_VisualServer_method_finish>` **(** **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`force_draw<class_VisualServer_method_force_draw>` **(** :ref:`bool<class_bool>` swap_buffers=true, :ref:`float<class_float>` frame_step=0.0 **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`force_sync<class_VisualServer_method_force_sync>` **(** **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`free_rid<class_VisualServer_method_free_rid>` **(** :ref:`RID<class_RID>` rid **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| :ref:`int<class_int>` | :ref:`get_render_info<class_VisualServer_method_get_render_info>` **(** :ref:`RenderInfo<enum_VisualServer_RenderInfo>` info **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| :ref:`RID<class_RID>` | :ref:`get_test_cube<class_VisualServer_method_get_test_cube>` **(** **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| :ref:`RID<class_RID>` | :ref:`get_test_texture<class_VisualServer_method_get_test_texture>` **(** **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| :ref:`String<class_String>` | :ref:`get_video_adapter_name<class_VisualServer_method_get_video_adapter_name>` **(** **)** |const| |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| :ref:`String<class_String>` | :ref:`get_video_adapter_vendor<class_VisualServer_method_get_video_adapter_vendor>` **(** **)** |const| |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| :ref:`RID<class_RID>` | :ref:`get_white_texture<class_VisualServer_method_get_white_texture>` **(** **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| :ref:`RID<class_RID>` | :ref:`gi_probe_create<class_VisualServer_method_gi_probe_create>` **(** **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| :ref:`float<class_float>` | :ref:`gi_probe_get_bias<class_VisualServer_method_gi_probe_get_bias>` **(** :ref:`RID<class_RID>` probe **)** |const| |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| :ref:`AABB<class_AABB>` | :ref:`gi_probe_get_bounds<class_VisualServer_method_gi_probe_get_bounds>` **(** :ref:`RID<class_RID>` probe **)** |const| |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| :ref:`float<class_float>` | :ref:`gi_probe_get_cell_size<class_VisualServer_method_gi_probe_get_cell_size>` **(** :ref:`RID<class_RID>` probe **)** |const| |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| :ref:`PoolIntArray<class_PoolIntArray>` | :ref:`gi_probe_get_dynamic_data<class_VisualServer_method_gi_probe_get_dynamic_data>` **(** :ref:`RID<class_RID>` probe **)** |const| |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| :ref:`int<class_int>` | :ref:`gi_probe_get_dynamic_range<class_VisualServer_method_gi_probe_get_dynamic_range>` **(** :ref:`RID<class_RID>` probe **)** |const| |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| :ref:`float<class_float>` | :ref:`gi_probe_get_energy<class_VisualServer_method_gi_probe_get_energy>` **(** :ref:`RID<class_RID>` probe **)** |const| |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| :ref:`float<class_float>` | :ref:`gi_probe_get_normal_bias<class_VisualServer_method_gi_probe_get_normal_bias>` **(** :ref:`RID<class_RID>` probe **)** |const| |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| :ref:`float<class_float>` | :ref:`gi_probe_get_propagation<class_VisualServer_method_gi_probe_get_propagation>` **(** :ref:`RID<class_RID>` probe **)** |const| |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| :ref:`Transform<class_Transform>` | :ref:`gi_probe_get_to_cell_xform<class_VisualServer_method_gi_probe_get_to_cell_xform>` **(** :ref:`RID<class_RID>` probe **)** |const| |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| :ref:`bool<class_bool>` | :ref:`gi_probe_is_compressed<class_VisualServer_method_gi_probe_is_compressed>` **(** :ref:`RID<class_RID>` probe **)** |const| |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| :ref:`bool<class_bool>` | :ref:`gi_probe_is_interior<class_VisualServer_method_gi_probe_is_interior>` **(** :ref:`RID<class_RID>` probe **)** |const| |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`gi_probe_set_bias<class_VisualServer_method_gi_probe_set_bias>` **(** :ref:`RID<class_RID>` probe, :ref:`float<class_float>` bias **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`gi_probe_set_bounds<class_VisualServer_method_gi_probe_set_bounds>` **(** :ref:`RID<class_RID>` probe, :ref:`AABB<class_AABB>` bounds **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`gi_probe_set_cell_size<class_VisualServer_method_gi_probe_set_cell_size>` **(** :ref:`RID<class_RID>` probe, :ref:`float<class_float>` range **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`gi_probe_set_compress<class_VisualServer_method_gi_probe_set_compress>` **(** :ref:`RID<class_RID>` probe, :ref:`bool<class_bool>` enable **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`gi_probe_set_dynamic_data<class_VisualServer_method_gi_probe_set_dynamic_data>` **(** :ref:`RID<class_RID>` probe, :ref:`PoolIntArray<class_PoolIntArray>` data **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`gi_probe_set_dynamic_range<class_VisualServer_method_gi_probe_set_dynamic_range>` **(** :ref:`RID<class_RID>` probe, :ref:`int<class_int>` range **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`gi_probe_set_energy<class_VisualServer_method_gi_probe_set_energy>` **(** :ref:`RID<class_RID>` probe, :ref:`float<class_float>` energy **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`gi_probe_set_interior<class_VisualServer_method_gi_probe_set_interior>` **(** :ref:`RID<class_RID>` probe, :ref:`bool<class_bool>` enable **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`gi_probe_set_normal_bias<class_VisualServer_method_gi_probe_set_normal_bias>` **(** :ref:`RID<class_RID>` probe, :ref:`float<class_float>` bias **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`gi_probe_set_propagation<class_VisualServer_method_gi_probe_set_propagation>` **(** :ref:`RID<class_RID>` probe, :ref:`float<class_float>` propagation **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`gi_probe_set_to_cell_xform<class_VisualServer_method_gi_probe_set_to_cell_xform>` **(** :ref:`RID<class_RID>` probe, :ref:`Transform<class_Transform>` xform **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| :ref:`bool<class_bool>` | :ref:`has_changed<class_VisualServer_method_has_changed>` **(** :ref:`ChangedPriority<enum_VisualServer_ChangedPriority>` queried_priority=0 **)** |const| |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| :ref:`bool<class_bool>` | :ref:`has_feature<class_VisualServer_method_has_feature>` **(** :ref:`Features<enum_VisualServer_Features>` feature **)** |const| |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| :ref:`bool<class_bool>` | :ref:`has_os_feature<class_VisualServer_method_has_os_feature>` **(** :ref:`String<class_String>` feature **)** |const| |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`immediate_begin<class_VisualServer_method_immediate_begin>` **(** :ref:`RID<class_RID>` immediate, :ref:`PrimitiveType<enum_VisualServer_PrimitiveType>` primitive, :ref:`RID<class_RID>` texture **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`immediate_clear<class_VisualServer_method_immediate_clear>` **(** :ref:`RID<class_RID>` immediate **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`immediate_color<class_VisualServer_method_immediate_color>` **(** :ref:`RID<class_RID>` immediate, :ref:`Color<class_Color>` color **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| :ref:`RID<class_RID>` | :ref:`immediate_create<class_VisualServer_method_immediate_create>` **(** **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`immediate_end<class_VisualServer_method_immediate_end>` **(** :ref:`RID<class_RID>` immediate **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| :ref:`RID<class_RID>` | :ref:`immediate_get_material<class_VisualServer_method_immediate_get_material>` **(** :ref:`RID<class_RID>` immediate **)** |const| |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`immediate_normal<class_VisualServer_method_immediate_normal>` **(** :ref:`RID<class_RID>` immediate, :ref:`Vector3<class_Vector3>` normal **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`immediate_set_material<class_VisualServer_method_immediate_set_material>` **(** :ref:`RID<class_RID>` immediate, :ref:`RID<class_RID>` material **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`immediate_tangent<class_VisualServer_method_immediate_tangent>` **(** :ref:`RID<class_RID>` immediate, :ref:`Plane<class_Plane>` tangent **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`immediate_uv<class_VisualServer_method_immediate_uv>` **(** :ref:`RID<class_RID>` immediate, :ref:`Vector2<class_Vector2>` tex_uv **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`immediate_uv2<class_VisualServer_method_immediate_uv2>` **(** :ref:`RID<class_RID>` immediate, :ref:`Vector2<class_Vector2>` tex_uv **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`immediate_vertex<class_VisualServer_method_immediate_vertex>` **(** :ref:`RID<class_RID>` immediate, :ref:`Vector3<class_Vector3>` vertex **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`immediate_vertex_2d<class_VisualServer_method_immediate_vertex_2d>` **(** :ref:`RID<class_RID>` immediate, :ref:`Vector2<class_Vector2>` vertex **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`init<class_VisualServer_method_init>` **(** **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`instance_attach_object_instance_id<class_VisualServer_method_instance_attach_object_instance_id>` **(** :ref:`RID<class_RID>` instance, :ref:`int<class_int>` id **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`instance_attach_skeleton<class_VisualServer_method_instance_attach_skeleton>` **(** :ref:`RID<class_RID>` instance, :ref:`RID<class_RID>` skeleton **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| :ref:`RID<class_RID>` | :ref:`instance_create<class_VisualServer_method_instance_create>` **(** **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| :ref:`RID<class_RID>` | :ref:`instance_create2<class_VisualServer_method_instance_create2>` **(** :ref:`RID<class_RID>` base, :ref:`RID<class_RID>` scenario **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`instance_geometry_set_as_instance_lod<class_VisualServer_method_instance_geometry_set_as_instance_lod>` **(** :ref:`RID<class_RID>` instance, :ref:`RID<class_RID>` as_lod_of_instance **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`instance_geometry_set_cast_shadows_setting<class_VisualServer_method_instance_geometry_set_cast_shadows_setting>` **(** :ref:`RID<class_RID>` instance, :ref:`ShadowCastingSetting<enum_VisualServer_ShadowCastingSetting>` shadow_casting_setting **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`instance_geometry_set_draw_range<class_VisualServer_method_instance_geometry_set_draw_range>` **(** :ref:`RID<class_RID>` instance, :ref:`float<class_float>` min, :ref:`float<class_float>` max, :ref:`float<class_float>` min_margin, :ref:`float<class_float>` max_margin **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`instance_geometry_set_flag<class_VisualServer_method_instance_geometry_set_flag>` **(** :ref:`RID<class_RID>` instance, :ref:`InstanceFlags<enum_VisualServer_InstanceFlags>` flag, :ref:`bool<class_bool>` enabled **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`instance_geometry_set_material_overlay<class_VisualServer_method_instance_geometry_set_material_overlay>` **(** :ref:`RID<class_RID>` instance, :ref:`RID<class_RID>` material **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`instance_geometry_set_material_override<class_VisualServer_method_instance_geometry_set_material_override>` **(** :ref:`RID<class_RID>` instance, :ref:`RID<class_RID>` material **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`instance_reset_physics_interpolation<class_VisualServer_method_instance_reset_physics_interpolation>` **(** :ref:`RID<class_RID>` instance **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`instance_set_base<class_VisualServer_method_instance_set_base>` **(** :ref:`RID<class_RID>` instance, :ref:`RID<class_RID>` base **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`instance_set_blend_shape_weight<class_VisualServer_method_instance_set_blend_shape_weight>` **(** :ref:`RID<class_RID>` instance, :ref:`int<class_int>` shape, :ref:`float<class_float>` weight **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`instance_set_custom_aabb<class_VisualServer_method_instance_set_custom_aabb>` **(** :ref:`RID<class_RID>` instance, :ref:`AABB<class_AABB>` aabb **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`instance_set_exterior<class_VisualServer_method_instance_set_exterior>` **(** :ref:`RID<class_RID>` instance, :ref:`bool<class_bool>` enabled **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`instance_set_extra_visibility_margin<class_VisualServer_method_instance_set_extra_visibility_margin>` **(** :ref:`RID<class_RID>` instance, :ref:`float<class_float>` margin **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`instance_set_interpolated<class_VisualServer_method_instance_set_interpolated>` **(** :ref:`RID<class_RID>` instance, :ref:`bool<class_bool>` interpolated **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`instance_set_layer_mask<class_VisualServer_method_instance_set_layer_mask>` **(** :ref:`RID<class_RID>` instance, :ref:`int<class_int>` mask **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`instance_set_scenario<class_VisualServer_method_instance_set_scenario>` **(** :ref:`RID<class_RID>` instance, :ref:`RID<class_RID>` scenario **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`instance_set_surface_material<class_VisualServer_method_instance_set_surface_material>` **(** :ref:`RID<class_RID>` instance, :ref:`int<class_int>` surface, :ref:`RID<class_RID>` material **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`instance_set_transform<class_VisualServer_method_instance_set_transform>` **(** :ref:`RID<class_RID>` instance, :ref:`Transform<class_Transform>` transform **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`instance_set_use_lightmap<class_VisualServer_method_instance_set_use_lightmap>` **(** :ref:`RID<class_RID>` instance, :ref:`RID<class_RID>` lightmap_instance, :ref:`RID<class_RID>` lightmap, :ref:`int<class_int>` lightmap_slice=-1, :ref:`Rect2<class_Rect2>` lightmap_uv_rect=Rect2( 0, 0, 1, 1 ) **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`instance_set_visible<class_VisualServer_method_instance_set_visible>` **(** :ref:`RID<class_RID>` instance, :ref:`bool<class_bool>` visible **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| :ref:`Array<class_Array>` | :ref:`instances_cull_aabb<class_VisualServer_method_instances_cull_aabb>` **(** :ref:`AABB<class_AABB>` aabb, :ref:`RID<class_RID>` scenario **)** |const| |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| :ref:`Array<class_Array>` | :ref:`instances_cull_convex<class_VisualServer_method_instances_cull_convex>` **(** :ref:`Array<class_Array>` convex, :ref:`RID<class_RID>` scenario **)** |const| |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| :ref:`Array<class_Array>` | :ref:`instances_cull_ray<class_VisualServer_method_instances_cull_ray>` **(** :ref:`Vector3<class_Vector3>` from, :ref:`Vector3<class_Vector3>` to, :ref:`RID<class_RID>` scenario **)** |const| |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`light_directional_set_blend_splits<class_VisualServer_method_light_directional_set_blend_splits>` **(** :ref:`RID<class_RID>` light, :ref:`bool<class_bool>` enable **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`light_directional_set_shadow_depth_range_mode<class_VisualServer_method_light_directional_set_shadow_depth_range_mode>` **(** :ref:`RID<class_RID>` light, :ref:`LightDirectionalShadowDepthRangeMode<enum_VisualServer_LightDirectionalShadowDepthRangeMode>` range_mode **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`light_directional_set_shadow_mode<class_VisualServer_method_light_directional_set_shadow_mode>` **(** :ref:`RID<class_RID>` light, :ref:`LightDirectionalShadowMode<enum_VisualServer_LightDirectionalShadowMode>` mode **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`light_omni_set_shadow_detail<class_VisualServer_method_light_omni_set_shadow_detail>` **(** :ref:`RID<class_RID>` light, :ref:`LightOmniShadowDetail<enum_VisualServer_LightOmniShadowDetail>` detail **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`light_omni_set_shadow_mode<class_VisualServer_method_light_omni_set_shadow_mode>` **(** :ref:`RID<class_RID>` light, :ref:`LightOmniShadowMode<enum_VisualServer_LightOmniShadowMode>` mode **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`light_set_bake_mode<class_VisualServer_method_light_set_bake_mode>` **(** :ref:`RID<class_RID>` light, :ref:`LightBakeMode<enum_VisualServer_LightBakeMode>` bake_mode **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`light_set_color<class_VisualServer_method_light_set_color>` **(** :ref:`RID<class_RID>` light, :ref:`Color<class_Color>` color **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`light_set_cull_mask<class_VisualServer_method_light_set_cull_mask>` **(** :ref:`RID<class_RID>` light, :ref:`int<class_int>` mask **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`light_set_negative<class_VisualServer_method_light_set_negative>` **(** :ref:`RID<class_RID>` light, :ref:`bool<class_bool>` enable **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`light_set_param<class_VisualServer_method_light_set_param>` **(** :ref:`RID<class_RID>` light, :ref:`LightParam<enum_VisualServer_LightParam>` param, :ref:`float<class_float>` value **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`light_set_projector<class_VisualServer_method_light_set_projector>` **(** :ref:`RID<class_RID>` light, :ref:`RID<class_RID>` texture **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`light_set_reverse_cull_face_mode<class_VisualServer_method_light_set_reverse_cull_face_mode>` **(** :ref:`RID<class_RID>` light, :ref:`bool<class_bool>` enabled **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`light_set_shadow<class_VisualServer_method_light_set_shadow>` **(** :ref:`RID<class_RID>` light, :ref:`bool<class_bool>` enabled **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`light_set_shadow_color<class_VisualServer_method_light_set_shadow_color>` **(** :ref:`RID<class_RID>` light, :ref:`Color<class_Color>` color **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`light_set_use_gi<class_VisualServer_method_light_set_use_gi>` **(** :ref:`RID<class_RID>` light, :ref:`bool<class_bool>` enabled **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| :ref:`RID<class_RID>` | :ref:`lightmap_capture_create<class_VisualServer_method_lightmap_capture_create>` **(** **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| :ref:`AABB<class_AABB>` | :ref:`lightmap_capture_get_bounds<class_VisualServer_method_lightmap_capture_get_bounds>` **(** :ref:`RID<class_RID>` capture **)** |const| |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| :ref:`float<class_float>` | :ref:`lightmap_capture_get_energy<class_VisualServer_method_lightmap_capture_get_energy>` **(** :ref:`RID<class_RID>` capture **)** |const| |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| :ref:`PoolByteArray<class_PoolByteArray>` | :ref:`lightmap_capture_get_octree<class_VisualServer_method_lightmap_capture_get_octree>` **(** :ref:`RID<class_RID>` capture **)** |const| |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| :ref:`int<class_int>` | :ref:`lightmap_capture_get_octree_cell_subdiv<class_VisualServer_method_lightmap_capture_get_octree_cell_subdiv>` **(** :ref:`RID<class_RID>` capture **)** |const| |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| :ref:`Transform<class_Transform>` | :ref:`lightmap_capture_get_octree_cell_transform<class_VisualServer_method_lightmap_capture_get_octree_cell_transform>` **(** :ref:`RID<class_RID>` capture **)** |const| |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| :ref:`bool<class_bool>` | :ref:`lightmap_capture_is_interior<class_VisualServer_method_lightmap_capture_is_interior>` **(** :ref:`RID<class_RID>` capture **)** |const| |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`lightmap_capture_set_bounds<class_VisualServer_method_lightmap_capture_set_bounds>` **(** :ref:`RID<class_RID>` capture, :ref:`AABB<class_AABB>` bounds **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`lightmap_capture_set_energy<class_VisualServer_method_lightmap_capture_set_energy>` **(** :ref:`RID<class_RID>` capture, :ref:`float<class_float>` energy **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`lightmap_capture_set_interior<class_VisualServer_method_lightmap_capture_set_interior>` **(** :ref:`RID<class_RID>` capture, :ref:`bool<class_bool>` interior **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`lightmap_capture_set_octree<class_VisualServer_method_lightmap_capture_set_octree>` **(** :ref:`RID<class_RID>` capture, :ref:`PoolByteArray<class_PoolByteArray>` octree **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`lightmap_capture_set_octree_cell_subdiv<class_VisualServer_method_lightmap_capture_set_octree_cell_subdiv>` **(** :ref:`RID<class_RID>` capture, :ref:`int<class_int>` subdiv **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`lightmap_capture_set_octree_cell_transform<class_VisualServer_method_lightmap_capture_set_octree_cell_transform>` **(** :ref:`RID<class_RID>` capture, :ref:`Transform<class_Transform>` xform **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| :ref:`RID<class_RID>` | :ref:`make_sphere_mesh<class_VisualServer_method_make_sphere_mesh>` **(** :ref:`int<class_int>` latitudes, :ref:`int<class_int>` longitudes, :ref:`float<class_float>` radius **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| :ref:`RID<class_RID>` | :ref:`material_create<class_VisualServer_method_material_create>` **(** **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| :ref:`Variant<class_Variant>` | :ref:`material_get_param<class_VisualServer_method_material_get_param>` **(** :ref:`RID<class_RID>` material, :ref:`String<class_String>` parameter **)** |const| |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| :ref:`Variant<class_Variant>` | :ref:`material_get_param_default<class_VisualServer_method_material_get_param_default>` **(** :ref:`RID<class_RID>` material, :ref:`String<class_String>` parameter **)** |const| |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| :ref:`RID<class_RID>` | :ref:`material_get_shader<class_VisualServer_method_material_get_shader>` **(** :ref:`RID<class_RID>` shader_material **)** |const| |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`material_set_line_width<class_VisualServer_method_material_set_line_width>` **(** :ref:`RID<class_RID>` material, :ref:`float<class_float>` width **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`material_set_next_pass<class_VisualServer_method_material_set_next_pass>` **(** :ref:`RID<class_RID>` material, :ref:`RID<class_RID>` next_material **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`material_set_param<class_VisualServer_method_material_set_param>` **(** :ref:`RID<class_RID>` material, :ref:`String<class_String>` parameter, :ref:`Variant<class_Variant>` value **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`material_set_render_priority<class_VisualServer_method_material_set_render_priority>` **(** :ref:`RID<class_RID>` material, :ref:`int<class_int>` priority **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`material_set_shader<class_VisualServer_method_material_set_shader>` **(** :ref:`RID<class_RID>` shader_material, :ref:`RID<class_RID>` shader **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`mesh_add_surface_from_arrays<class_VisualServer_method_mesh_add_surface_from_arrays>` **(** :ref:`RID<class_RID>` mesh, :ref:`PrimitiveType<enum_VisualServer_PrimitiveType>` primitive, :ref:`Array<class_Array>` arrays, :ref:`Array<class_Array>` blend_shapes=[ ], :ref:`int<class_int>` compress_format=2194432 **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`mesh_clear<class_VisualServer_method_mesh_clear>` **(** :ref:`RID<class_RID>` mesh **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| :ref:`RID<class_RID>` | :ref:`mesh_create<class_VisualServer_method_mesh_create>` **(** **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| :ref:`int<class_int>` | :ref:`mesh_get_blend_shape_count<class_VisualServer_method_mesh_get_blend_shape_count>` **(** :ref:`RID<class_RID>` mesh **)** |const| |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| :ref:`BlendShapeMode<enum_VisualServer_BlendShapeMode>` | :ref:`mesh_get_blend_shape_mode<class_VisualServer_method_mesh_get_blend_shape_mode>` **(** :ref:`RID<class_RID>` mesh **)** |const| |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| :ref:`AABB<class_AABB>` | :ref:`mesh_get_custom_aabb<class_VisualServer_method_mesh_get_custom_aabb>` **(** :ref:`RID<class_RID>` mesh **)** |const| |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| :ref:`int<class_int>` | :ref:`mesh_get_surface_count<class_VisualServer_method_mesh_get_surface_count>` **(** :ref:`RID<class_RID>` mesh **)** |const| |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`mesh_remove_surface<class_VisualServer_method_mesh_remove_surface>` **(** :ref:`RID<class_RID>` mesh, :ref:`int<class_int>` index **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`mesh_set_blend_shape_count<class_VisualServer_method_mesh_set_blend_shape_count>` **(** :ref:`RID<class_RID>` mesh, :ref:`int<class_int>` amount **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`mesh_set_blend_shape_mode<class_VisualServer_method_mesh_set_blend_shape_mode>` **(** :ref:`RID<class_RID>` mesh, :ref:`BlendShapeMode<enum_VisualServer_BlendShapeMode>` mode **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`mesh_set_custom_aabb<class_VisualServer_method_mesh_set_custom_aabb>` **(** :ref:`RID<class_RID>` mesh, :ref:`AABB<class_AABB>` aabb **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| :ref:`AABB<class_AABB>` | :ref:`mesh_surface_get_aabb<class_VisualServer_method_mesh_surface_get_aabb>` **(** :ref:`RID<class_RID>` mesh, :ref:`int<class_int>` surface **)** |const| |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| :ref:`PoolByteArray<class_PoolByteArray>` | :ref:`mesh_surface_get_array<class_VisualServer_method_mesh_surface_get_array>` **(** :ref:`RID<class_RID>` mesh, :ref:`int<class_int>` surface **)** |const| |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| :ref:`int<class_int>` | :ref:`mesh_surface_get_array_index_len<class_VisualServer_method_mesh_surface_get_array_index_len>` **(** :ref:`RID<class_RID>` mesh, :ref:`int<class_int>` surface **)** |const| |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| :ref:`int<class_int>` | :ref:`mesh_surface_get_array_len<class_VisualServer_method_mesh_surface_get_array_len>` **(** :ref:`RID<class_RID>` mesh, :ref:`int<class_int>` surface **)** |const| |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| :ref:`Array<class_Array>` | :ref:`mesh_surface_get_arrays<class_VisualServer_method_mesh_surface_get_arrays>` **(** :ref:`RID<class_RID>` mesh, :ref:`int<class_int>` surface **)** |const| |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| :ref:`Array<class_Array>` | :ref:`mesh_surface_get_blend_shape_arrays<class_VisualServer_method_mesh_surface_get_blend_shape_arrays>` **(** :ref:`RID<class_RID>` mesh, :ref:`int<class_int>` surface **)** |const| |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| :ref:`int<class_int>` | :ref:`mesh_surface_get_format<class_VisualServer_method_mesh_surface_get_format>` **(** :ref:`RID<class_RID>` mesh, :ref:`int<class_int>` surface **)** |const| |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| :ref:`int<class_int>` | :ref:`mesh_surface_get_format_offset<class_VisualServer_method_mesh_surface_get_format_offset>` **(** :ref:`int<class_int>` format, :ref:`int<class_int>` vertex_len, :ref:`int<class_int>` index_len, :ref:`int<class_int>` array_index **)** |const| |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| :ref:`int<class_int>` | :ref:`mesh_surface_get_format_stride<class_VisualServer_method_mesh_surface_get_format_stride>` **(** :ref:`int<class_int>` format, :ref:`int<class_int>` vertex_len, :ref:`int<class_int>` index_len, :ref:`int<class_int>` array_index **)** |const| |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| :ref:`PoolByteArray<class_PoolByteArray>` | :ref:`mesh_surface_get_index_array<class_VisualServer_method_mesh_surface_get_index_array>` **(** :ref:`RID<class_RID>` mesh, :ref:`int<class_int>` surface **)** |const| |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| :ref:`RID<class_RID>` | :ref:`mesh_surface_get_material<class_VisualServer_method_mesh_surface_get_material>` **(** :ref:`RID<class_RID>` mesh, :ref:`int<class_int>` surface **)** |const| |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| :ref:`PrimitiveType<enum_VisualServer_PrimitiveType>` | :ref:`mesh_surface_get_primitive_type<class_VisualServer_method_mesh_surface_get_primitive_type>` **(** :ref:`RID<class_RID>` mesh, :ref:`int<class_int>` surface **)** |const| |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| :ref:`Array<class_Array>` | :ref:`mesh_surface_get_skeleton_aabb<class_VisualServer_method_mesh_surface_get_skeleton_aabb>` **(** :ref:`RID<class_RID>` mesh, :ref:`int<class_int>` surface **)** |const| |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`mesh_surface_set_material<class_VisualServer_method_mesh_surface_set_material>` **(** :ref:`RID<class_RID>` mesh, :ref:`int<class_int>` surface, :ref:`RID<class_RID>` material **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`mesh_surface_update_region<class_VisualServer_method_mesh_surface_update_region>` **(** :ref:`RID<class_RID>` mesh, :ref:`int<class_int>` surface, :ref:`int<class_int>` offset, :ref:`PoolByteArray<class_PoolByteArray>` data **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`multimesh_allocate<class_VisualServer_method_multimesh_allocate>` **(** :ref:`RID<class_RID>` multimesh, :ref:`int<class_int>` instances, :ref:`MultimeshTransformFormat<enum_VisualServer_MultimeshTransformFormat>` transform_format, :ref:`MultimeshColorFormat<enum_VisualServer_MultimeshColorFormat>` color_format, :ref:`MultimeshCustomDataFormat<enum_VisualServer_MultimeshCustomDataFormat>` custom_data_format=0 **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| :ref:`RID<class_RID>` | :ref:`multimesh_create<class_VisualServer_method_multimesh_create>` **(** **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| :ref:`AABB<class_AABB>` | :ref:`multimesh_get_aabb<class_VisualServer_method_multimesh_get_aabb>` **(** :ref:`RID<class_RID>` multimesh **)** |const| |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| :ref:`int<class_int>` | :ref:`multimesh_get_instance_count<class_VisualServer_method_multimesh_get_instance_count>` **(** :ref:`RID<class_RID>` multimesh **)** |const| |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| :ref:`RID<class_RID>` | :ref:`multimesh_get_mesh<class_VisualServer_method_multimesh_get_mesh>` **(** :ref:`RID<class_RID>` multimesh **)** |const| |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| :ref:`int<class_int>` | :ref:`multimesh_get_visible_instances<class_VisualServer_method_multimesh_get_visible_instances>` **(** :ref:`RID<class_RID>` multimesh **)** |const| |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| :ref:`Color<class_Color>` | :ref:`multimesh_instance_get_color<class_VisualServer_method_multimesh_instance_get_color>` **(** :ref:`RID<class_RID>` multimesh, :ref:`int<class_int>` index **)** |const| |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| :ref:`Color<class_Color>` | :ref:`multimesh_instance_get_custom_data<class_VisualServer_method_multimesh_instance_get_custom_data>` **(** :ref:`RID<class_RID>` multimesh, :ref:`int<class_int>` index **)** |const| |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| :ref:`Transform<class_Transform>` | :ref:`multimesh_instance_get_transform<class_VisualServer_method_multimesh_instance_get_transform>` **(** :ref:`RID<class_RID>` multimesh, :ref:`int<class_int>` index **)** |const| |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| :ref:`Transform2D<class_Transform2D>` | :ref:`multimesh_instance_get_transform_2d<class_VisualServer_method_multimesh_instance_get_transform_2d>` **(** :ref:`RID<class_RID>` multimesh, :ref:`int<class_int>` index **)** |const| |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`multimesh_instance_reset_physics_interpolation<class_VisualServer_method_multimesh_instance_reset_physics_interpolation>` **(** :ref:`RID<class_RID>` multimesh, :ref:`int<class_int>` index **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`multimesh_instance_set_color<class_VisualServer_method_multimesh_instance_set_color>` **(** :ref:`RID<class_RID>` multimesh, :ref:`int<class_int>` index, :ref:`Color<class_Color>` color **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`multimesh_instance_set_custom_data<class_VisualServer_method_multimesh_instance_set_custom_data>` **(** :ref:`RID<class_RID>` multimesh, :ref:`int<class_int>` index, :ref:`Color<class_Color>` custom_data **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`multimesh_instance_set_transform<class_VisualServer_method_multimesh_instance_set_transform>` **(** :ref:`RID<class_RID>` multimesh, :ref:`int<class_int>` index, :ref:`Transform<class_Transform>` transform **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`multimesh_instance_set_transform_2d<class_VisualServer_method_multimesh_instance_set_transform_2d>` **(** :ref:`RID<class_RID>` multimesh, :ref:`int<class_int>` index, :ref:`Transform2D<class_Transform2D>` transform **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`multimesh_set_as_bulk_array<class_VisualServer_method_multimesh_set_as_bulk_array>` **(** :ref:`RID<class_RID>` multimesh, :ref:`PoolRealArray<class_PoolRealArray>` array **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`multimesh_set_as_bulk_array_interpolated<class_VisualServer_method_multimesh_set_as_bulk_array_interpolated>` **(** :ref:`RID<class_RID>` multimesh, :ref:`PoolRealArray<class_PoolRealArray>` array, :ref:`PoolRealArray<class_PoolRealArray>` array_previous **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`multimesh_set_mesh<class_VisualServer_method_multimesh_set_mesh>` **(** :ref:`RID<class_RID>` multimesh, :ref:`RID<class_RID>` mesh **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`multimesh_set_physics_interpolated<class_VisualServer_method_multimesh_set_physics_interpolated>` **(** :ref:`RID<class_RID>` multimesh, :ref:`bool<class_bool>` interpolated **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`multimesh_set_physics_interpolation_quality<class_VisualServer_method_multimesh_set_physics_interpolation_quality>` **(** :ref:`RID<class_RID>` multimesh, :ref:`MultimeshPhysicsInterpolationQuality<enum_VisualServer_MultimeshPhysicsInterpolationQuality>` quality **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`multimesh_set_visible_instances<class_VisualServer_method_multimesh_set_visible_instances>` **(** :ref:`RID<class_RID>` multimesh, :ref:`int<class_int>` visible **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| :ref:`RID<class_RID>` | :ref:`omni_light_create<class_VisualServer_method_omni_light_create>` **(** **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| :ref:`RID<class_RID>` | :ref:`particles_create<class_VisualServer_method_particles_create>` **(** **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| :ref:`AABB<class_AABB>` | :ref:`particles_get_current_aabb<class_VisualServer_method_particles_get_current_aabb>` **(** :ref:`RID<class_RID>` particles **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| :ref:`bool<class_bool>` | :ref:`particles_get_emitting<class_VisualServer_method_particles_get_emitting>` **(** :ref:`RID<class_RID>` particles **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| :ref:`bool<class_bool>` | :ref:`particles_is_inactive<class_VisualServer_method_particles_is_inactive>` **(** :ref:`RID<class_RID>` particles **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`particles_request_process<class_VisualServer_method_particles_request_process>` **(** :ref:`RID<class_RID>` particles **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`particles_restart<class_VisualServer_method_particles_restart>` **(** :ref:`RID<class_RID>` particles **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`particles_set_amount<class_VisualServer_method_particles_set_amount>` **(** :ref:`RID<class_RID>` particles, :ref:`int<class_int>` amount **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`particles_set_custom_aabb<class_VisualServer_method_particles_set_custom_aabb>` **(** :ref:`RID<class_RID>` particles, :ref:`AABB<class_AABB>` aabb **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`particles_set_draw_order<class_VisualServer_method_particles_set_draw_order>` **(** :ref:`RID<class_RID>` particles, :ref:`ParticlesDrawOrder<enum_VisualServer_ParticlesDrawOrder>` order **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`particles_set_draw_pass_mesh<class_VisualServer_method_particles_set_draw_pass_mesh>` **(** :ref:`RID<class_RID>` particles, :ref:`int<class_int>` pass, :ref:`RID<class_RID>` mesh **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`particles_set_draw_passes<class_VisualServer_method_particles_set_draw_passes>` **(** :ref:`RID<class_RID>` particles, :ref:`int<class_int>` count **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`particles_set_emission_transform<class_VisualServer_method_particles_set_emission_transform>` **(** :ref:`RID<class_RID>` particles, :ref:`Transform<class_Transform>` transform **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`particles_set_emitting<class_VisualServer_method_particles_set_emitting>` **(** :ref:`RID<class_RID>` particles, :ref:`bool<class_bool>` emitting **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`particles_set_explosiveness_ratio<class_VisualServer_method_particles_set_explosiveness_ratio>` **(** :ref:`RID<class_RID>` particles, :ref:`float<class_float>` ratio **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`particles_set_fixed_fps<class_VisualServer_method_particles_set_fixed_fps>` **(** :ref:`RID<class_RID>` particles, :ref:`int<class_int>` fps **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`particles_set_fractional_delta<class_VisualServer_method_particles_set_fractional_delta>` **(** :ref:`RID<class_RID>` particles, :ref:`bool<class_bool>` enable **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`particles_set_lifetime<class_VisualServer_method_particles_set_lifetime>` **(** :ref:`RID<class_RID>` particles, :ref:`float<class_float>` lifetime **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`particles_set_one_shot<class_VisualServer_method_particles_set_one_shot>` **(** :ref:`RID<class_RID>` particles, :ref:`bool<class_bool>` one_shot **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`particles_set_pre_process_time<class_VisualServer_method_particles_set_pre_process_time>` **(** :ref:`RID<class_RID>` particles, :ref:`float<class_float>` time **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`particles_set_process_material<class_VisualServer_method_particles_set_process_material>` **(** :ref:`RID<class_RID>` particles, :ref:`RID<class_RID>` material **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`particles_set_randomness_ratio<class_VisualServer_method_particles_set_randomness_ratio>` **(** :ref:`RID<class_RID>` particles, :ref:`float<class_float>` ratio **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`particles_set_speed_scale<class_VisualServer_method_particles_set_speed_scale>` **(** :ref:`RID<class_RID>` particles, :ref:`float<class_float>` scale **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`particles_set_use_local_coordinates<class_VisualServer_method_particles_set_use_local_coordinates>` **(** :ref:`RID<class_RID>` particles, :ref:`bool<class_bool>` enable **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| :ref:`RID<class_RID>` | :ref:`reflection_probe_create<class_VisualServer_method_reflection_probe_create>` **(** **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`reflection_probe_set_as_interior<class_VisualServer_method_reflection_probe_set_as_interior>` **(** :ref:`RID<class_RID>` probe, :ref:`bool<class_bool>` enable **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`reflection_probe_set_cull_mask<class_VisualServer_method_reflection_probe_set_cull_mask>` **(** :ref:`RID<class_RID>` probe, :ref:`int<class_int>` layers **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`reflection_probe_set_enable_box_projection<class_VisualServer_method_reflection_probe_set_enable_box_projection>` **(** :ref:`RID<class_RID>` probe, :ref:`bool<class_bool>` enable **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`reflection_probe_set_enable_shadows<class_VisualServer_method_reflection_probe_set_enable_shadows>` **(** :ref:`RID<class_RID>` probe, :ref:`bool<class_bool>` enable **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`reflection_probe_set_extents<class_VisualServer_method_reflection_probe_set_extents>` **(** :ref:`RID<class_RID>` probe, :ref:`Vector3<class_Vector3>` extents **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`reflection_probe_set_intensity<class_VisualServer_method_reflection_probe_set_intensity>` **(** :ref:`RID<class_RID>` probe, :ref:`float<class_float>` intensity **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`reflection_probe_set_interior_ambient<class_VisualServer_method_reflection_probe_set_interior_ambient>` **(** :ref:`RID<class_RID>` probe, :ref:`Color<class_Color>` color **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`reflection_probe_set_interior_ambient_energy<class_VisualServer_method_reflection_probe_set_interior_ambient_energy>` **(** :ref:`RID<class_RID>` probe, :ref:`float<class_float>` energy **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`reflection_probe_set_interior_ambient_probe_contribution<class_VisualServer_method_reflection_probe_set_interior_ambient_probe_contribution>` **(** :ref:`RID<class_RID>` probe, :ref:`float<class_float>` contrib **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`reflection_probe_set_max_distance<class_VisualServer_method_reflection_probe_set_max_distance>` **(** :ref:`RID<class_RID>` probe, :ref:`float<class_float>` distance **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`reflection_probe_set_origin_offset<class_VisualServer_method_reflection_probe_set_origin_offset>` **(** :ref:`RID<class_RID>` probe, :ref:`Vector3<class_Vector3>` offset **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`reflection_probe_set_update_mode<class_VisualServer_method_reflection_probe_set_update_mode>` **(** :ref:`RID<class_RID>` probe, :ref:`ReflectionProbeUpdateMode<enum_VisualServer_ReflectionProbeUpdateMode>` mode **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`request_frame_drawn_callback<class_VisualServer_method_request_frame_drawn_callback>` **(** :ref:`Object<class_Object>` where, :ref:`String<class_String>` method, :ref:`Variant<class_Variant>` userdata **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| :ref:`RID<class_RID>` | :ref:`scenario_create<class_VisualServer_method_scenario_create>` **(** **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`scenario_set_debug<class_VisualServer_method_scenario_set_debug>` **(** :ref:`RID<class_RID>` scenario, :ref:`ScenarioDebugMode<enum_VisualServer_ScenarioDebugMode>` debug_mode **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`scenario_set_environment<class_VisualServer_method_scenario_set_environment>` **(** :ref:`RID<class_RID>` scenario, :ref:`RID<class_RID>` environment **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`scenario_set_fallback_environment<class_VisualServer_method_scenario_set_fallback_environment>` **(** :ref:`RID<class_RID>` scenario, :ref:`RID<class_RID>` environment **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`scenario_set_reflection_atlas_size<class_VisualServer_method_scenario_set_reflection_atlas_size>` **(** :ref:`RID<class_RID>` scenario, :ref:`int<class_int>` size, :ref:`int<class_int>` subdiv **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`set_boot_image<class_VisualServer_method_set_boot_image>` **(** :ref:`Image<class_Image>` image, :ref:`Color<class_Color>` color, :ref:`bool<class_bool>` scale, :ref:`bool<class_bool>` use_filter=true **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`set_debug_generate_wireframes<class_VisualServer_method_set_debug_generate_wireframes>` **(** :ref:`bool<class_bool>` generate **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`set_default_clear_color<class_VisualServer_method_set_default_clear_color>` **(** :ref:`Color<class_Color>` color **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`set_shader_async_hidden_forbidden<class_VisualServer_method_set_shader_async_hidden_forbidden>` **(** :ref:`bool<class_bool>` forbidden **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`set_shader_time_scale<class_VisualServer_method_set_shader_time_scale>` **(** :ref:`float<class_float>` scale **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`set_use_occlusion_culling<class_VisualServer_method_set_use_occlusion_culling>` **(** :ref:`bool<class_bool>` enable **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| :ref:`RID<class_RID>` | :ref:`shader_create<class_VisualServer_method_shader_create>` **(** **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| :ref:`String<class_String>` | :ref:`shader_get_code<class_VisualServer_method_shader_get_code>` **(** :ref:`RID<class_RID>` shader **)** |const| |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| :ref:`RID<class_RID>` | :ref:`shader_get_default_texture_param<class_VisualServer_method_shader_get_default_texture_param>` **(** :ref:`RID<class_RID>` shader, :ref:`String<class_String>` name **)** |const| |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| :ref:`Array<class_Array>` | :ref:`shader_get_param_list<class_VisualServer_method_shader_get_param_list>` **(** :ref:`RID<class_RID>` shader **)** |const| |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`shader_set_code<class_VisualServer_method_shader_set_code>` **(** :ref:`RID<class_RID>` shader, :ref:`String<class_String>` code **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`shader_set_default_texture_param<class_VisualServer_method_shader_set_default_texture_param>` **(** :ref:`RID<class_RID>` shader, :ref:`String<class_String>` name, :ref:`RID<class_RID>` texture **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`skeleton_allocate<class_VisualServer_method_skeleton_allocate>` **(** :ref:`RID<class_RID>` skeleton, :ref:`int<class_int>` bones, :ref:`bool<class_bool>` is_2d_skeleton=false **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| :ref:`Transform<class_Transform>` | :ref:`skeleton_bone_get_transform<class_VisualServer_method_skeleton_bone_get_transform>` **(** :ref:`RID<class_RID>` skeleton, :ref:`int<class_int>` bone **)** |const| |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| :ref:`Transform2D<class_Transform2D>` | :ref:`skeleton_bone_get_transform_2d<class_VisualServer_method_skeleton_bone_get_transform_2d>` **(** :ref:`RID<class_RID>` skeleton, :ref:`int<class_int>` bone **)** |const| |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`skeleton_bone_set_transform<class_VisualServer_method_skeleton_bone_set_transform>` **(** :ref:`RID<class_RID>` skeleton, :ref:`int<class_int>` bone, :ref:`Transform<class_Transform>` transform **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`skeleton_bone_set_transform_2d<class_VisualServer_method_skeleton_bone_set_transform_2d>` **(** :ref:`RID<class_RID>` skeleton, :ref:`int<class_int>` bone, :ref:`Transform2D<class_Transform2D>` transform **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| :ref:`RID<class_RID>` | :ref:`skeleton_create<class_VisualServer_method_skeleton_create>` **(** **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| :ref:`int<class_int>` | :ref:`skeleton_get_bone_count<class_VisualServer_method_skeleton_get_bone_count>` **(** :ref:`RID<class_RID>` skeleton **)** |const| |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| :ref:`RID<class_RID>` | :ref:`sky_create<class_VisualServer_method_sky_create>` **(** **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`sky_set_texture<class_VisualServer_method_sky_set_texture>` **(** :ref:`RID<class_RID>` sky, :ref:`RID<class_RID>` cube_map, :ref:`int<class_int>` radiance_size **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| :ref:`RID<class_RID>` | :ref:`spot_light_create<class_VisualServer_method_spot_light_create>` **(** **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`sync<class_VisualServer_method_sync>` **(** **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`texture_allocate<class_VisualServer_method_texture_allocate>` **(** :ref:`RID<class_RID>` texture, :ref:`int<class_int>` width, :ref:`int<class_int>` height, :ref:`int<class_int>` depth_3d, :ref:`Format<enum_Image_Format>` format, :ref:`TextureType<enum_VisualServer_TextureType>` type, :ref:`int<class_int>` flags=7 **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`texture_bind<class_VisualServer_method_texture_bind>` **(** :ref:`RID<class_RID>` texture, :ref:`int<class_int>` number **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| :ref:`RID<class_RID>` | :ref:`texture_create<class_VisualServer_method_texture_create>` **(** **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| :ref:`RID<class_RID>` | :ref:`texture_create_from_image<class_VisualServer_method_texture_create_from_image>` **(** :ref:`Image<class_Image>` image, :ref:`int<class_int>` flags=7 **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| :ref:`Array<class_Array>` | :ref:`texture_debug_usage<class_VisualServer_method_texture_debug_usage>` **(** **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| :ref:`Image<class_Image>` | :ref:`texture_get_data<class_VisualServer_method_texture_get_data>` **(** :ref:`RID<class_RID>` texture, :ref:`int<class_int>` cube_side=0 **)** |const| |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| :ref:`int<class_int>` | :ref:`texture_get_depth<class_VisualServer_method_texture_get_depth>` **(** :ref:`RID<class_RID>` texture **)** |const| |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| :ref:`int<class_int>` | :ref:`texture_get_flags<class_VisualServer_method_texture_get_flags>` **(** :ref:`RID<class_RID>` texture **)** |const| |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| :ref:`Format<enum_Image_Format>` | :ref:`texture_get_format<class_VisualServer_method_texture_get_format>` **(** :ref:`RID<class_RID>` texture **)** |const| |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| :ref:`int<class_int>` | :ref:`texture_get_height<class_VisualServer_method_texture_get_height>` **(** :ref:`RID<class_RID>` texture **)** |const| |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| :ref:`String<class_String>` | :ref:`texture_get_path<class_VisualServer_method_texture_get_path>` **(** :ref:`RID<class_RID>` texture **)** |const| |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| :ref:`int<class_int>` | :ref:`texture_get_texid<class_VisualServer_method_texture_get_texid>` **(** :ref:`RID<class_RID>` texture **)** |const| |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| :ref:`TextureType<enum_VisualServer_TextureType>` | :ref:`texture_get_type<class_VisualServer_method_texture_get_type>` **(** :ref:`RID<class_RID>` texture **)** |const| |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| :ref:`int<class_int>` | :ref:`texture_get_width<class_VisualServer_method_texture_get_width>` **(** :ref:`RID<class_RID>` texture **)** |const| |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`texture_set_data<class_VisualServer_method_texture_set_data>` **(** :ref:`RID<class_RID>` texture, :ref:`Image<class_Image>` image, :ref:`int<class_int>` layer=0 **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`texture_set_data_partial<class_VisualServer_method_texture_set_data_partial>` **(** :ref:`RID<class_RID>` texture, :ref:`Image<class_Image>` image, :ref:`int<class_int>` src_x, :ref:`int<class_int>` src_y, :ref:`int<class_int>` src_w, :ref:`int<class_int>` src_h, :ref:`int<class_int>` dst_x, :ref:`int<class_int>` dst_y, :ref:`int<class_int>` dst_mip, :ref:`int<class_int>` layer=0 **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`texture_set_flags<class_VisualServer_method_texture_set_flags>` **(** :ref:`RID<class_RID>` texture, :ref:`int<class_int>` flags **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`texture_set_path<class_VisualServer_method_texture_set_path>` **(** :ref:`RID<class_RID>` texture, :ref:`String<class_String>` path **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`texture_set_proxy<class_VisualServer_method_texture_set_proxy>` **(** :ref:`RID<class_RID>` proxy, :ref:`RID<class_RID>` base **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`texture_set_shrink_all_x2_on_set_data<class_VisualServer_method_texture_set_shrink_all_x2_on_set_data>` **(** :ref:`bool<class_bool>` shrink **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`texture_set_size_override<class_VisualServer_method_texture_set_size_override>` **(** :ref:`RID<class_RID>` texture, :ref:`int<class_int>` width, :ref:`int<class_int>` height, :ref:`int<class_int>` depth **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`textures_keep_original<class_VisualServer_method_textures_keep_original>` **(** :ref:`bool<class_bool>` enable **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`viewport_attach_camera<class_VisualServer_method_viewport_attach_camera>` **(** :ref:`RID<class_RID>` viewport, :ref:`RID<class_RID>` camera **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`viewport_attach_canvas<class_VisualServer_method_viewport_attach_canvas>` **(** :ref:`RID<class_RID>` viewport, :ref:`RID<class_RID>` canvas **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`viewport_attach_to_screen<class_VisualServer_method_viewport_attach_to_screen>` **(** :ref:`RID<class_RID>` viewport, :ref:`Rect2<class_Rect2>` rect=Rect2( 0, 0, 0, 0 ), :ref:`int<class_int>` screen=0 **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| :ref:`RID<class_RID>` | :ref:`viewport_create<class_VisualServer_method_viewport_create>` **(** **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`viewport_detach<class_VisualServer_method_viewport_detach>` **(** :ref:`RID<class_RID>` viewport **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| :ref:`int<class_int>` | :ref:`viewport_get_render_info<class_VisualServer_method_viewport_get_render_info>` **(** :ref:`RID<class_RID>` viewport, :ref:`ViewportRenderInfo<enum_VisualServer_ViewportRenderInfo>` info **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| :ref:`RID<class_RID>` | :ref:`viewport_get_texture<class_VisualServer_method_viewport_get_texture>` **(** :ref:`RID<class_RID>` viewport **)** |const| |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`viewport_remove_canvas<class_VisualServer_method_viewport_remove_canvas>` **(** :ref:`RID<class_RID>` viewport, :ref:`RID<class_RID>` canvas **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`viewport_set_active<class_VisualServer_method_viewport_set_active>` **(** :ref:`RID<class_RID>` viewport, :ref:`bool<class_bool>` active **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`viewport_set_canvas_stacking<class_VisualServer_method_viewport_set_canvas_stacking>` **(** :ref:`RID<class_RID>` viewport, :ref:`RID<class_RID>` canvas, :ref:`int<class_int>` layer, :ref:`int<class_int>` sublayer **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`viewport_set_canvas_transform<class_VisualServer_method_viewport_set_canvas_transform>` **(** :ref:`RID<class_RID>` viewport, :ref:`RID<class_RID>` canvas, :ref:`Transform2D<class_Transform2D>` offset **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`viewport_set_clear_mode<class_VisualServer_method_viewport_set_clear_mode>` **(** :ref:`RID<class_RID>` viewport, :ref:`ViewportClearMode<enum_VisualServer_ViewportClearMode>` clear_mode **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`viewport_set_debug_draw<class_VisualServer_method_viewport_set_debug_draw>` **(** :ref:`RID<class_RID>` viewport, :ref:`ViewportDebugDraw<enum_VisualServer_ViewportDebugDraw>` draw **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`viewport_set_disable_3d<class_VisualServer_method_viewport_set_disable_3d>` **(** :ref:`RID<class_RID>` viewport, :ref:`bool<class_bool>` disabled **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`viewport_set_disable_environment<class_VisualServer_method_viewport_set_disable_environment>` **(** :ref:`RID<class_RID>` viewport, :ref:`bool<class_bool>` disabled **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`viewport_set_global_canvas_transform<class_VisualServer_method_viewport_set_global_canvas_transform>` **(** :ref:`RID<class_RID>` viewport, :ref:`Transform2D<class_Transform2D>` transform **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`viewport_set_hdr<class_VisualServer_method_viewport_set_hdr>` **(** :ref:`RID<class_RID>` viewport, :ref:`bool<class_bool>` enabled **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`viewport_set_hide_canvas<class_VisualServer_method_viewport_set_hide_canvas>` **(** :ref:`RID<class_RID>` viewport, :ref:`bool<class_bool>` hidden **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`viewport_set_hide_scenario<class_VisualServer_method_viewport_set_hide_scenario>` **(** :ref:`RID<class_RID>` viewport, :ref:`bool<class_bool>` hidden **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`viewport_set_msaa<class_VisualServer_method_viewport_set_msaa>` **(** :ref:`RID<class_RID>` viewport, :ref:`ViewportMSAA<enum_VisualServer_ViewportMSAA>` msaa **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`viewport_set_parent_viewport<class_VisualServer_method_viewport_set_parent_viewport>` **(** :ref:`RID<class_RID>` viewport, :ref:`RID<class_RID>` parent_viewport **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`viewport_set_render_direct_to_screen<class_VisualServer_method_viewport_set_render_direct_to_screen>` **(** :ref:`RID<class_RID>` viewport, :ref:`bool<class_bool>` enabled **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`viewport_set_scenario<class_VisualServer_method_viewport_set_scenario>` **(** :ref:`RID<class_RID>` viewport, :ref:`RID<class_RID>` scenario **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`viewport_set_shadow_atlas_quadrant_subdivision<class_VisualServer_method_viewport_set_shadow_atlas_quadrant_subdivision>` **(** :ref:`RID<class_RID>` viewport, :ref:`int<class_int>` quadrant, :ref:`int<class_int>` subdivision **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`viewport_set_shadow_atlas_size<class_VisualServer_method_viewport_set_shadow_atlas_size>` **(** :ref:`RID<class_RID>` viewport, :ref:`int<class_int>` size **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`viewport_set_sharpen_intensity<class_VisualServer_method_viewport_set_sharpen_intensity>` **(** :ref:`RID<class_RID>` viewport, :ref:`float<class_float>` intensity **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`viewport_set_size<class_VisualServer_method_viewport_set_size>` **(** :ref:`RID<class_RID>` viewport, :ref:`int<class_int>` width, :ref:`int<class_int>` height **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`viewport_set_transparent_background<class_VisualServer_method_viewport_set_transparent_background>` **(** :ref:`RID<class_RID>` viewport, :ref:`bool<class_bool>` enabled **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`viewport_set_update_mode<class_VisualServer_method_viewport_set_update_mode>` **(** :ref:`RID<class_RID>` viewport, :ref:`ViewportUpdateMode<enum_VisualServer_ViewportUpdateMode>` update_mode **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`viewport_set_usage<class_VisualServer_method_viewport_set_usage>` **(** :ref:`RID<class_RID>` viewport, :ref:`ViewportUsage<enum_VisualServer_ViewportUsage>` usage **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`viewport_set_use_32_bpc_depth<class_VisualServer_method_viewport_set_use_32_bpc_depth>` **(** :ref:`RID<class_RID>` viewport, :ref:`bool<class_bool>` enabled **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`viewport_set_use_arvr<class_VisualServer_method_viewport_set_use_arvr>` **(** :ref:`RID<class_RID>` viewport, :ref:`bool<class_bool>` use_arvr **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`viewport_set_use_debanding<class_VisualServer_method_viewport_set_use_debanding>` **(** :ref:`RID<class_RID>` viewport, :ref:`bool<class_bool>` debanding **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`viewport_set_use_fxaa<class_VisualServer_method_viewport_set_use_fxaa>` **(** :ref:`RID<class_RID>` viewport, :ref:`bool<class_bool>` fxaa **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
| void | :ref:`viewport_set_vflip<class_VisualServer_method_viewport_set_vflip>` **(** :ref:`RID<class_RID>` viewport, :ref:`bool<class_bool>` enabled **)** |
|
|||
|
|
+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|||
|
|
|
|||
|
|
Signals
|
|||
|
|
-------
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_signal_frame_post_draw:
|
|||
|
|
|
|||
|
|
- **frame_post_draw** **(** **)**
|
|||
|
|
|
|||
|
|
Emitted at the end of the frame, after the VisualServer has finished updating all the Viewports.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_signal_frame_pre_draw:
|
|||
|
|
|
|||
|
|
- **frame_pre_draw** **(** **)**
|
|||
|
|
|
|||
|
|
Emitted at the beginning of the frame, before the VisualServer updates all the Viewports.
|
|||
|
|
|
|||
|
|
Enumerations
|
|||
|
|
------------
|
|||
|
|
|
|||
|
|
.. _enum_VisualServer_CubeMapSide:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_CUBEMAP_LEFT:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_CUBEMAP_RIGHT:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_CUBEMAP_BOTTOM:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_CUBEMAP_TOP:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_CUBEMAP_FRONT:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_CUBEMAP_BACK:
|
|||
|
|
|
|||
|
|
enum **CubeMapSide**:
|
|||
|
|
|
|||
|
|
- **CUBEMAP_LEFT** = **0** --- Marks the left side of a cubemap.
|
|||
|
|
|
|||
|
|
- **CUBEMAP_RIGHT** = **1** --- Marks the right side of a cubemap.
|
|||
|
|
|
|||
|
|
- **CUBEMAP_BOTTOM** = **2** --- Marks the bottom side of a cubemap.
|
|||
|
|
|
|||
|
|
- **CUBEMAP_TOP** = **3** --- Marks the top side of a cubemap.
|
|||
|
|
|
|||
|
|
- **CUBEMAP_FRONT** = **4** --- Marks the front side of a cubemap.
|
|||
|
|
|
|||
|
|
- **CUBEMAP_BACK** = **5** --- Marks the back side of a cubemap.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _enum_VisualServer_TextureType:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_TEXTURE_TYPE_2D:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_TEXTURE_TYPE_CUBEMAP:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_TEXTURE_TYPE_2D_ARRAY:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_TEXTURE_TYPE_3D:
|
|||
|
|
|
|||
|
|
enum **TextureType**:
|
|||
|
|
|
|||
|
|
- **TEXTURE_TYPE_2D** = **0** --- Normal texture with 2 dimensions, width and height.
|
|||
|
|
|
|||
|
|
- **TEXTURE_TYPE_CUBEMAP** = **2** --- Texture made up of six faces, can be looked up with a ``vec3`` in shader.
|
|||
|
|
|
|||
|
|
- **TEXTURE_TYPE_2D_ARRAY** = **3** --- An array of 2-dimensional textures.
|
|||
|
|
|
|||
|
|
- **TEXTURE_TYPE_3D** = **4** --- A 3-dimensional texture with width, height, and depth.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _enum_VisualServer_TextureFlags:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_TEXTURE_FLAG_MIPMAPS:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_TEXTURE_FLAG_REPEAT:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_TEXTURE_FLAG_FILTER:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_TEXTURE_FLAG_ANISOTROPIC_FILTER:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_TEXTURE_FLAG_CONVERT_TO_LINEAR:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_TEXTURE_FLAG_MIRRORED_REPEAT:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_TEXTURE_FLAG_USED_FOR_STREAMING:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_TEXTURE_FLAGS_DEFAULT:
|
|||
|
|
|
|||
|
|
enum **TextureFlags**:
|
|||
|
|
|
|||
|
|
- **TEXTURE_FLAG_MIPMAPS** = **1** --- Generates mipmaps, which are smaller versions of the same texture to use when zoomed out, keeping the aspect ratio.
|
|||
|
|
|
|||
|
|
- **TEXTURE_FLAG_REPEAT** = **2** --- Repeats the texture (instead of clamp to edge).
|
|||
|
|
|
|||
|
|
- **TEXTURE_FLAG_FILTER** = **4** --- Uses a magnifying filter, to enable smooth zooming in of the texture.
|
|||
|
|
|
|||
|
|
- **TEXTURE_FLAG_ANISOTROPIC_FILTER** = **8** --- Uses anisotropic mipmap filtering. Generates smaller versions of the same texture with different aspect ratios.
|
|||
|
|
|
|||
|
|
This results in better-looking textures when viewed from oblique angles.
|
|||
|
|
|
|||
|
|
- **TEXTURE_FLAG_CONVERT_TO_LINEAR** = **16** --- Converts the texture to the sRGB color space.
|
|||
|
|
|
|||
|
|
- **TEXTURE_FLAG_MIRRORED_REPEAT** = **32** --- Repeats the texture with alternate sections mirrored.
|
|||
|
|
|
|||
|
|
- **TEXTURE_FLAG_USED_FOR_STREAMING** = **2048** --- Texture is a video surface.
|
|||
|
|
|
|||
|
|
- **TEXTURE_FLAGS_DEFAULT** = **7** --- Default flags. :ref:`TEXTURE_FLAG_MIPMAPS<class_VisualServer_constant_TEXTURE_FLAG_MIPMAPS>`, :ref:`TEXTURE_FLAG_REPEAT<class_VisualServer_constant_TEXTURE_FLAG_REPEAT>` and :ref:`TEXTURE_FLAG_FILTER<class_VisualServer_constant_TEXTURE_FLAG_FILTER>` are enabled.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _enum_VisualServer_ShaderMode:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_SHADER_SPATIAL:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_SHADER_CANVAS_ITEM:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_SHADER_PARTICLES:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_SHADER_MAX:
|
|||
|
|
|
|||
|
|
enum **ShaderMode**:
|
|||
|
|
|
|||
|
|
- **SHADER_SPATIAL** = **0** --- Shader is a 3D shader.
|
|||
|
|
|
|||
|
|
- **SHADER_CANVAS_ITEM** = **1** --- Shader is a 2D shader.
|
|||
|
|
|
|||
|
|
- **SHADER_PARTICLES** = **2** --- Shader is a particle shader.
|
|||
|
|
|
|||
|
|
- **SHADER_MAX** = **3** --- Represents the size of the :ref:`ShaderMode<enum_VisualServer_ShaderMode>` enum.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _enum_VisualServer_ArrayType:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_ARRAY_VERTEX:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_ARRAY_NORMAL:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_ARRAY_TANGENT:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_ARRAY_COLOR:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_ARRAY_TEX_UV:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_ARRAY_TEX_UV2:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_ARRAY_BONES:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_ARRAY_WEIGHTS:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_ARRAY_INDEX:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_ARRAY_MAX:
|
|||
|
|
|
|||
|
|
enum **ArrayType**:
|
|||
|
|
|
|||
|
|
- **ARRAY_VERTEX** = **0** --- Array is a vertex array.
|
|||
|
|
|
|||
|
|
- **ARRAY_NORMAL** = **1** --- Array is a normal array.
|
|||
|
|
|
|||
|
|
- **ARRAY_TANGENT** = **2** --- Array is a tangent array.
|
|||
|
|
|
|||
|
|
- **ARRAY_COLOR** = **3** --- Array is a color array.
|
|||
|
|
|
|||
|
|
- **ARRAY_TEX_UV** = **4** --- Array is an UV coordinates array.
|
|||
|
|
|
|||
|
|
- **ARRAY_TEX_UV2** = **5** --- Array is an UV coordinates array for the second UV coordinates.
|
|||
|
|
|
|||
|
|
- **ARRAY_BONES** = **6** --- Array contains bone information.
|
|||
|
|
|
|||
|
|
- **ARRAY_WEIGHTS** = **7** --- Array is weight information.
|
|||
|
|
|
|||
|
|
- **ARRAY_INDEX** = **8** --- Array is index array.
|
|||
|
|
|
|||
|
|
- **ARRAY_MAX** = **9** --- Represents the size of the :ref:`ArrayType<enum_VisualServer_ArrayType>` enum.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _enum_VisualServer_ArrayFormat:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_ARRAY_FORMAT_VERTEX:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_ARRAY_FORMAT_NORMAL:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_ARRAY_FORMAT_TANGENT:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_ARRAY_FORMAT_COLOR:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_ARRAY_FORMAT_TEX_UV:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_ARRAY_FORMAT_TEX_UV2:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_ARRAY_FORMAT_BONES:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_ARRAY_FORMAT_WEIGHTS:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_ARRAY_FORMAT_INDEX:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_ARRAY_COMPRESS_VERTEX:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_ARRAY_COMPRESS_NORMAL:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_ARRAY_COMPRESS_TANGENT:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_ARRAY_COMPRESS_COLOR:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_ARRAY_COMPRESS_TEX_UV:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_ARRAY_COMPRESS_TEX_UV2:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_ARRAY_COMPRESS_BONES:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_ARRAY_COMPRESS_WEIGHTS:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_ARRAY_COMPRESS_INDEX:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_ARRAY_FLAG_USE_2D_VERTICES:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_ARRAY_FLAG_USE_16_BIT_BONES:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_ARRAY_FLAG_USE_OCTAHEDRAL_COMPRESSION:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_ARRAY_COMPRESS_DEFAULT:
|
|||
|
|
|
|||
|
|
enum **ArrayFormat**:
|
|||
|
|
|
|||
|
|
- **ARRAY_FORMAT_VERTEX** = **1** --- Flag used to mark a vertex array.
|
|||
|
|
|
|||
|
|
- **ARRAY_FORMAT_NORMAL** = **2** --- Flag used to mark a normal array.
|
|||
|
|
|
|||
|
|
- **ARRAY_FORMAT_TANGENT** = **4** --- Flag used to mark a tangent array.
|
|||
|
|
|
|||
|
|
- **ARRAY_FORMAT_COLOR** = **8** --- Flag used to mark a color array.
|
|||
|
|
|
|||
|
|
- **ARRAY_FORMAT_TEX_UV** = **16** --- Flag used to mark an UV coordinates array.
|
|||
|
|
|
|||
|
|
- **ARRAY_FORMAT_TEX_UV2** = **32** --- Flag used to mark an UV coordinates array for the second UV coordinates.
|
|||
|
|
|
|||
|
|
- **ARRAY_FORMAT_BONES** = **64** --- Flag used to mark a bone information array.
|
|||
|
|
|
|||
|
|
- **ARRAY_FORMAT_WEIGHTS** = **128** --- Flag used to mark a weights array.
|
|||
|
|
|
|||
|
|
- **ARRAY_FORMAT_INDEX** = **256** --- Flag used to mark an index array.
|
|||
|
|
|
|||
|
|
- **ARRAY_COMPRESS_VERTEX** = **512** --- Flag used to mark a compressed (half float) vertex array.
|
|||
|
|
|
|||
|
|
- **ARRAY_COMPRESS_NORMAL** = **1024** --- Flag used to mark a compressed (half float) normal array.
|
|||
|
|
|
|||
|
|
- **ARRAY_COMPRESS_TANGENT** = **2048** --- Flag used to mark a compressed (half float) tangent array.
|
|||
|
|
|
|||
|
|
- **ARRAY_COMPRESS_COLOR** = **4096** --- Flag used to mark a compressed (half float) color array.
|
|||
|
|
|
|||
|
|
- **ARRAY_COMPRESS_TEX_UV** = **8192** --- Flag used to mark a compressed (half float) UV coordinates array.
|
|||
|
|
|
|||
|
|
- **ARRAY_COMPRESS_TEX_UV2** = **16384** --- Flag used to mark a compressed (half float) UV coordinates array for the second UV coordinates.
|
|||
|
|
|
|||
|
|
- **ARRAY_COMPRESS_BONES** = **32768** --- Flag used to mark a compressed bone array.
|
|||
|
|
|
|||
|
|
- **ARRAY_COMPRESS_WEIGHTS** = **65536** --- Flag used to mark a compressed (half float) weight array.
|
|||
|
|
|
|||
|
|
- **ARRAY_COMPRESS_INDEX** = **131072** --- Flag used to mark a compressed index array.
|
|||
|
|
|
|||
|
|
- **ARRAY_FLAG_USE_2D_VERTICES** = **262144** --- Flag used to mark that the array contains 2D vertices.
|
|||
|
|
|
|||
|
|
- **ARRAY_FLAG_USE_16_BIT_BONES** = **524288** --- Flag used to mark that the array uses 16-bit bones instead of 8-bit.
|
|||
|
|
|
|||
|
|
- **ARRAY_FLAG_USE_OCTAHEDRAL_COMPRESSION** = **2097152** --- Flag used to mark that the array uses an octahedral representation of normal and tangent vectors rather than cartesian.
|
|||
|
|
|
|||
|
|
- **ARRAY_COMPRESS_DEFAULT** = **2194432** --- Used to set flags :ref:`ARRAY_COMPRESS_NORMAL<class_VisualServer_constant_ARRAY_COMPRESS_NORMAL>`, :ref:`ARRAY_COMPRESS_TANGENT<class_VisualServer_constant_ARRAY_COMPRESS_TANGENT>`, :ref:`ARRAY_COMPRESS_COLOR<class_VisualServer_constant_ARRAY_COMPRESS_COLOR>`, :ref:`ARRAY_COMPRESS_TEX_UV<class_VisualServer_constant_ARRAY_COMPRESS_TEX_UV>`, :ref:`ARRAY_COMPRESS_TEX_UV2<class_VisualServer_constant_ARRAY_COMPRESS_TEX_UV2>`, :ref:`ARRAY_COMPRESS_WEIGHTS<class_VisualServer_constant_ARRAY_COMPRESS_WEIGHTS>`, and :ref:`ARRAY_FLAG_USE_OCTAHEDRAL_COMPRESSION<class_VisualServer_constant_ARRAY_FLAG_USE_OCTAHEDRAL_COMPRESSION>` quickly.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _enum_VisualServer_PrimitiveType:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_PRIMITIVE_POINTS:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_PRIMITIVE_LINES:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_PRIMITIVE_LINE_STRIP:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_PRIMITIVE_LINE_LOOP:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_PRIMITIVE_TRIANGLES:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_PRIMITIVE_TRIANGLE_STRIP:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_PRIMITIVE_TRIANGLE_FAN:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_PRIMITIVE_MAX:
|
|||
|
|
|
|||
|
|
enum **PrimitiveType**:
|
|||
|
|
|
|||
|
|
- **PRIMITIVE_POINTS** = **0** --- Primitive to draw consists of points.
|
|||
|
|
|
|||
|
|
- **PRIMITIVE_LINES** = **1** --- Primitive to draw consists of lines.
|
|||
|
|
|
|||
|
|
- **PRIMITIVE_LINE_STRIP** = **2** --- Primitive to draw consists of a line strip from start to end.
|
|||
|
|
|
|||
|
|
- **PRIMITIVE_LINE_LOOP** = **3** --- Primitive to draw consists of a line loop (a line strip with a line between the last and the first vertex).
|
|||
|
|
|
|||
|
|
- **PRIMITIVE_TRIANGLES** = **4** --- Primitive to draw consists of triangles.
|
|||
|
|
|
|||
|
|
- **PRIMITIVE_TRIANGLE_STRIP** = **5** --- Primitive to draw consists of a triangle strip (the last 3 vertices are always combined to make a triangle).
|
|||
|
|
|
|||
|
|
- **PRIMITIVE_TRIANGLE_FAN** = **6** --- Primitive to draw consists of a triangle strip (the last 2 vertices are always combined with the first to make a triangle).
|
|||
|
|
|
|||
|
|
- **PRIMITIVE_MAX** = **7** --- Represents the size of the :ref:`PrimitiveType<enum_VisualServer_PrimitiveType>` enum.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _enum_VisualServer_BlendShapeMode:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_BLEND_SHAPE_MODE_NORMALIZED:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_BLEND_SHAPE_MODE_RELATIVE:
|
|||
|
|
|
|||
|
|
enum **BlendShapeMode**:
|
|||
|
|
|
|||
|
|
- **BLEND_SHAPE_MODE_NORMALIZED** = **0** --- Blend shapes are normalized.
|
|||
|
|
|
|||
|
|
- **BLEND_SHAPE_MODE_RELATIVE** = **1** --- Blend shapes are relative to base weight.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _enum_VisualServer_LightType:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_LIGHT_DIRECTIONAL:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_LIGHT_OMNI:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_LIGHT_SPOT:
|
|||
|
|
|
|||
|
|
enum **LightType**:
|
|||
|
|
|
|||
|
|
- **LIGHT_DIRECTIONAL** = **0** --- Is a directional (sun) light.
|
|||
|
|
|
|||
|
|
- **LIGHT_OMNI** = **1** --- Is an omni light.
|
|||
|
|
|
|||
|
|
- **LIGHT_SPOT** = **2** --- Is a spot light.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _enum_VisualServer_LightParam:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_LIGHT_PARAM_ENERGY:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_LIGHT_PARAM_INDIRECT_ENERGY:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_LIGHT_PARAM_SIZE:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_LIGHT_PARAM_SPECULAR:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_LIGHT_PARAM_RANGE:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_LIGHT_PARAM_ATTENUATION:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_LIGHT_PARAM_SPOT_ANGLE:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_LIGHT_PARAM_SPOT_ATTENUATION:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_LIGHT_PARAM_CONTACT_SHADOW_SIZE:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_LIGHT_PARAM_SHADOW_MAX_DISTANCE:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_LIGHT_PARAM_SHADOW_SPLIT_1_OFFSET:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_LIGHT_PARAM_SHADOW_SPLIT_2_OFFSET:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_LIGHT_PARAM_SHADOW_SPLIT_3_OFFSET:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_LIGHT_PARAM_SHADOW_NORMAL_BIAS:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_LIGHT_PARAM_SHADOW_BIAS:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_LIGHT_PARAM_SHADOW_BIAS_SPLIT_SCALE:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_LIGHT_PARAM_MAX:
|
|||
|
|
|
|||
|
|
enum **LightParam**:
|
|||
|
|
|
|||
|
|
- **LIGHT_PARAM_ENERGY** = **0** --- The light's energy.
|
|||
|
|
|
|||
|
|
- **LIGHT_PARAM_INDIRECT_ENERGY** = **1** --- Secondary multiplier used with indirect light (light bounces).
|
|||
|
|
|
|||
|
|
- **LIGHT_PARAM_SIZE** = **2** --- The light's size, currently only used for soft shadows in baked lightmaps.
|
|||
|
|
|
|||
|
|
- **LIGHT_PARAM_SPECULAR** = **3** --- The light's influence on specularity.
|
|||
|
|
|
|||
|
|
- **LIGHT_PARAM_RANGE** = **4** --- The light's range.
|
|||
|
|
|
|||
|
|
- **LIGHT_PARAM_ATTENUATION** = **5** --- The light's attenuation.
|
|||
|
|
|
|||
|
|
- **LIGHT_PARAM_SPOT_ANGLE** = **6** --- The spotlight's angle.
|
|||
|
|
|
|||
|
|
- **LIGHT_PARAM_SPOT_ATTENUATION** = **7** --- The spotlight's attenuation.
|
|||
|
|
|
|||
|
|
- **LIGHT_PARAM_CONTACT_SHADOW_SIZE** = **8** --- Scales the shadow color.
|
|||
|
|
|
|||
|
|
- **LIGHT_PARAM_SHADOW_MAX_DISTANCE** = **9** --- Max distance that shadows will be rendered.
|
|||
|
|
|
|||
|
|
- **LIGHT_PARAM_SHADOW_SPLIT_1_OFFSET** = **10** --- Proportion of shadow atlas occupied by the first split.
|
|||
|
|
|
|||
|
|
- **LIGHT_PARAM_SHADOW_SPLIT_2_OFFSET** = **11** --- Proportion of shadow atlas occupied by the second split.
|
|||
|
|
|
|||
|
|
- **LIGHT_PARAM_SHADOW_SPLIT_3_OFFSET** = **12** --- Proportion of shadow atlas occupied by the third split. The fourth split occupies the rest.
|
|||
|
|
|
|||
|
|
- **LIGHT_PARAM_SHADOW_NORMAL_BIAS** = **13** --- Normal bias used to offset shadow lookup by object normal. Can be used to fix self-shadowing artifacts.
|
|||
|
|
|
|||
|
|
- **LIGHT_PARAM_SHADOW_BIAS** = **14** --- Bias the shadow lookup to fix self-shadowing artifacts.
|
|||
|
|
|
|||
|
|
- **LIGHT_PARAM_SHADOW_BIAS_SPLIT_SCALE** = **15** --- Increases bias on further splits to fix self-shadowing that only occurs far away from the camera.
|
|||
|
|
|
|||
|
|
- **LIGHT_PARAM_MAX** = **16** --- Represents the size of the :ref:`LightParam<enum_VisualServer_LightParam>` enum.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _enum_VisualServer_LightBakeMode:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_LIGHT_BAKE_DISABLED:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_LIGHT_BAKE_INDIRECT:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_LIGHT_BAKE_ALL:
|
|||
|
|
|
|||
|
|
enum **LightBakeMode**:
|
|||
|
|
|
|||
|
|
- **LIGHT_BAKE_DISABLED** = **0**
|
|||
|
|
|
|||
|
|
- **LIGHT_BAKE_INDIRECT** = **1**
|
|||
|
|
|
|||
|
|
- **LIGHT_BAKE_ALL** = **2**
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _enum_VisualServer_LightOmniShadowMode:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_LIGHT_OMNI_SHADOW_DUAL_PARABOLOID:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_LIGHT_OMNI_SHADOW_CUBE:
|
|||
|
|
|
|||
|
|
enum **LightOmniShadowMode**:
|
|||
|
|
|
|||
|
|
- **LIGHT_OMNI_SHADOW_DUAL_PARABOLOID** = **0** --- Use a dual paraboloid shadow map for omni lights.
|
|||
|
|
|
|||
|
|
- **LIGHT_OMNI_SHADOW_CUBE** = **1** --- Use a cubemap shadow map for omni lights. Slower but better quality than dual paraboloid.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _enum_VisualServer_LightOmniShadowDetail:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_LIGHT_OMNI_SHADOW_DETAIL_VERTICAL:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_LIGHT_OMNI_SHADOW_DETAIL_HORIZONTAL:
|
|||
|
|
|
|||
|
|
enum **LightOmniShadowDetail**:
|
|||
|
|
|
|||
|
|
- **LIGHT_OMNI_SHADOW_DETAIL_VERTICAL** = **0** --- Use more detail vertically when computing shadow map.
|
|||
|
|
|
|||
|
|
- **LIGHT_OMNI_SHADOW_DETAIL_HORIZONTAL** = **1** --- Use more detail horizontally when computing shadow map.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _enum_VisualServer_LightDirectionalShadowMode:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_LIGHT_DIRECTIONAL_SHADOW_ORTHOGONAL:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_LIGHT_DIRECTIONAL_SHADOW_PARALLEL_2_SPLITS:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_LIGHT_DIRECTIONAL_SHADOW_PARALLEL_4_SPLITS:
|
|||
|
|
|
|||
|
|
enum **LightDirectionalShadowMode**:
|
|||
|
|
|
|||
|
|
- **LIGHT_DIRECTIONAL_SHADOW_ORTHOGONAL** = **0** --- Use orthogonal shadow projection for directional light.
|
|||
|
|
|
|||
|
|
- **LIGHT_DIRECTIONAL_SHADOW_PARALLEL_2_SPLITS** = **1** --- Use 2 splits for shadow projection when using directional light.
|
|||
|
|
|
|||
|
|
- **LIGHT_DIRECTIONAL_SHADOW_PARALLEL_4_SPLITS** = **2** --- Use 4 splits for shadow projection when using directional light.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _enum_VisualServer_LightDirectionalShadowDepthRangeMode:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_LIGHT_DIRECTIONAL_SHADOW_DEPTH_RANGE_STABLE:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_LIGHT_DIRECTIONAL_SHADOW_DEPTH_RANGE_OPTIMIZED:
|
|||
|
|
|
|||
|
|
enum **LightDirectionalShadowDepthRangeMode**:
|
|||
|
|
|
|||
|
|
- **LIGHT_DIRECTIONAL_SHADOW_DEPTH_RANGE_STABLE** = **0** --- Keeps shadows stable as camera moves but has lower effective resolution.
|
|||
|
|
|
|||
|
|
- **LIGHT_DIRECTIONAL_SHADOW_DEPTH_RANGE_OPTIMIZED** = **1** --- Optimize use of shadow maps, increasing the effective resolution. But may result in shadows moving or flickering slightly.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _enum_VisualServer_ViewportUpdateMode:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_VIEWPORT_UPDATE_DISABLED:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_VIEWPORT_UPDATE_ONCE:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_VIEWPORT_UPDATE_WHEN_VISIBLE:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_VIEWPORT_UPDATE_ALWAYS:
|
|||
|
|
|
|||
|
|
enum **ViewportUpdateMode**:
|
|||
|
|
|
|||
|
|
- **VIEWPORT_UPDATE_DISABLED** = **0** --- Do not update the viewport.
|
|||
|
|
|
|||
|
|
- **VIEWPORT_UPDATE_ONCE** = **1** --- Update the viewport once then set to disabled.
|
|||
|
|
|
|||
|
|
- **VIEWPORT_UPDATE_WHEN_VISIBLE** = **2** --- Update the viewport whenever it is visible.
|
|||
|
|
|
|||
|
|
- **VIEWPORT_UPDATE_ALWAYS** = **3** --- Always update the viewport.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _enum_VisualServer_ViewportClearMode:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_VIEWPORT_CLEAR_ALWAYS:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_VIEWPORT_CLEAR_NEVER:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_VIEWPORT_CLEAR_ONLY_NEXT_FRAME:
|
|||
|
|
|
|||
|
|
enum **ViewportClearMode**:
|
|||
|
|
|
|||
|
|
- **VIEWPORT_CLEAR_ALWAYS** = **0** --- The viewport is always cleared before drawing.
|
|||
|
|
|
|||
|
|
- **VIEWPORT_CLEAR_NEVER** = **1** --- The viewport is never cleared before drawing.
|
|||
|
|
|
|||
|
|
- **VIEWPORT_CLEAR_ONLY_NEXT_FRAME** = **2** --- The viewport is cleared once, then the clear mode is set to :ref:`VIEWPORT_CLEAR_NEVER<class_VisualServer_constant_VIEWPORT_CLEAR_NEVER>`.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _enum_VisualServer_ViewportMSAA:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_VIEWPORT_MSAA_DISABLED:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_VIEWPORT_MSAA_2X:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_VIEWPORT_MSAA_4X:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_VIEWPORT_MSAA_8X:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_VIEWPORT_MSAA_16X:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_VIEWPORT_MSAA_EXT_2X:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_VIEWPORT_MSAA_EXT_4X:
|
|||
|
|
|
|||
|
|
enum **ViewportMSAA**:
|
|||
|
|
|
|||
|
|
- **VIEWPORT_MSAA_DISABLED** = **0** --- Multisample antialiasing is disabled.
|
|||
|
|
|
|||
|
|
- **VIEWPORT_MSAA_2X** = **1** --- Multisample antialiasing is set to 2×.
|
|||
|
|
|
|||
|
|
- **VIEWPORT_MSAA_4X** = **2** --- Multisample antialiasing is set to 4×.
|
|||
|
|
|
|||
|
|
- **VIEWPORT_MSAA_8X** = **3** --- Multisample antialiasing is set to 8×.
|
|||
|
|
|
|||
|
|
- **VIEWPORT_MSAA_16X** = **4** --- Multisample antialiasing is set to 16×.
|
|||
|
|
|
|||
|
|
- **VIEWPORT_MSAA_EXT_2X** = **5** --- Multisample antialiasing is set to 2× on external texture. Special mode for GLES2 Android VR (Oculus Quest and Go).
|
|||
|
|
|
|||
|
|
- **VIEWPORT_MSAA_EXT_4X** = **6** --- Multisample antialiasing is set to 4× on external texture. Special mode for GLES2 Android VR (Oculus Quest and Go).
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _enum_VisualServer_ViewportUsage:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_VIEWPORT_USAGE_2D:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_VIEWPORT_USAGE_2D_NO_SAMPLING:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_VIEWPORT_USAGE_3D:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_VIEWPORT_USAGE_3D_NO_EFFECTS:
|
|||
|
|
|
|||
|
|
enum **ViewportUsage**:
|
|||
|
|
|
|||
|
|
- **VIEWPORT_USAGE_2D** = **0** --- The Viewport does not render 3D but samples.
|
|||
|
|
|
|||
|
|
- **VIEWPORT_USAGE_2D_NO_SAMPLING** = **1** --- The Viewport does not render 3D and does not sample.
|
|||
|
|
|
|||
|
|
- **VIEWPORT_USAGE_3D** = **2** --- The Viewport renders 3D with effects.
|
|||
|
|
|
|||
|
|
- **VIEWPORT_USAGE_3D_NO_EFFECTS** = **3** --- The Viewport renders 3D but without effects.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _enum_VisualServer_ViewportRenderInfo:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_VIEWPORT_RENDER_INFO_OBJECTS_IN_FRAME:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_VIEWPORT_RENDER_INFO_VERTICES_IN_FRAME:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_VIEWPORT_RENDER_INFO_MATERIAL_CHANGES_IN_FRAME:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_VIEWPORT_RENDER_INFO_SHADER_CHANGES_IN_FRAME:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_VIEWPORT_RENDER_INFO_SURFACE_CHANGES_IN_FRAME:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_VIEWPORT_RENDER_INFO_DRAW_CALLS_IN_FRAME:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_VIEWPORT_RENDER_INFO_2D_ITEMS_IN_FRAME:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_VIEWPORT_RENDER_INFO_2D_DRAW_CALLS_IN_FRAME:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_VIEWPORT_RENDER_INFO_MAX:
|
|||
|
|
|
|||
|
|
enum **ViewportRenderInfo**:
|
|||
|
|
|
|||
|
|
- **VIEWPORT_RENDER_INFO_OBJECTS_IN_FRAME** = **0** --- Number of objects drawn in a single frame.
|
|||
|
|
|
|||
|
|
- **VIEWPORT_RENDER_INFO_VERTICES_IN_FRAME** = **1** --- Number of vertices drawn in a single frame.
|
|||
|
|
|
|||
|
|
- **VIEWPORT_RENDER_INFO_MATERIAL_CHANGES_IN_FRAME** = **2** --- Number of material changes during this frame.
|
|||
|
|
|
|||
|
|
- **VIEWPORT_RENDER_INFO_SHADER_CHANGES_IN_FRAME** = **3** --- Number of shader changes during this frame.
|
|||
|
|
|
|||
|
|
- **VIEWPORT_RENDER_INFO_SURFACE_CHANGES_IN_FRAME** = **4** --- Number of surface changes during this frame.
|
|||
|
|
|
|||
|
|
- **VIEWPORT_RENDER_INFO_DRAW_CALLS_IN_FRAME** = **5** --- Number of draw calls during this frame.
|
|||
|
|
|
|||
|
|
- **VIEWPORT_RENDER_INFO_2D_ITEMS_IN_FRAME** = **6** --- Number of 2d items drawn this frame.
|
|||
|
|
|
|||
|
|
- **VIEWPORT_RENDER_INFO_2D_DRAW_CALLS_IN_FRAME** = **7** --- Number of 2d draw calls during this frame.
|
|||
|
|
|
|||
|
|
- **VIEWPORT_RENDER_INFO_MAX** = **8** --- Represents the size of the :ref:`ViewportRenderInfo<enum_VisualServer_ViewportRenderInfo>` enum.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _enum_VisualServer_ViewportDebugDraw:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_VIEWPORT_DEBUG_DRAW_DISABLED:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_VIEWPORT_DEBUG_DRAW_UNSHADED:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_VIEWPORT_DEBUG_DRAW_OVERDRAW:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_VIEWPORT_DEBUG_DRAW_WIREFRAME:
|
|||
|
|
|
|||
|
|
enum **ViewportDebugDraw**:
|
|||
|
|
|
|||
|
|
- **VIEWPORT_DEBUG_DRAW_DISABLED** = **0** --- Debug draw is disabled. Default setting.
|
|||
|
|
|
|||
|
|
- **VIEWPORT_DEBUG_DRAW_UNSHADED** = **1** --- Debug draw sets objects to unshaded.
|
|||
|
|
|
|||
|
|
- **VIEWPORT_DEBUG_DRAW_OVERDRAW** = **2** --- Overwrites clear color to ``(0,0,0,0)``.
|
|||
|
|
|
|||
|
|
- **VIEWPORT_DEBUG_DRAW_WIREFRAME** = **3** --- Debug draw draws objects in wireframe.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _enum_VisualServer_ScenarioDebugMode:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_SCENARIO_DEBUG_DISABLED:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_SCENARIO_DEBUG_WIREFRAME:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_SCENARIO_DEBUG_OVERDRAW:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_SCENARIO_DEBUG_SHADELESS:
|
|||
|
|
|
|||
|
|
enum **ScenarioDebugMode**:
|
|||
|
|
|
|||
|
|
- **SCENARIO_DEBUG_DISABLED** = **0** --- Do not use a debug mode.
|
|||
|
|
|
|||
|
|
- **SCENARIO_DEBUG_WIREFRAME** = **1** --- Draw all objects as wireframe models.
|
|||
|
|
|
|||
|
|
- **SCENARIO_DEBUG_OVERDRAW** = **2** --- Draw all objects in a way that displays how much overdraw is occurring. Overdraw occurs when a section of pixels is drawn and shaded and then another object covers it up. To optimize a scene, you should reduce overdraw.
|
|||
|
|
|
|||
|
|
- **SCENARIO_DEBUG_SHADELESS** = **3** --- Draw all objects without shading. Equivalent to setting all objects shaders to ``unshaded``.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _enum_VisualServer_InstanceType:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_INSTANCE_NONE:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_INSTANCE_MESH:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_INSTANCE_MULTIMESH:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_INSTANCE_IMMEDIATE:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_INSTANCE_PARTICLES:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_INSTANCE_LIGHT:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_INSTANCE_REFLECTION_PROBE:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_INSTANCE_GI_PROBE:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_INSTANCE_LIGHTMAP_CAPTURE:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_INSTANCE_MAX:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_INSTANCE_GEOMETRY_MASK:
|
|||
|
|
|
|||
|
|
enum **InstanceType**:
|
|||
|
|
|
|||
|
|
- **INSTANCE_NONE** = **0** --- The instance does not have a type.
|
|||
|
|
|
|||
|
|
- **INSTANCE_MESH** = **1** --- The instance is a mesh.
|
|||
|
|
|
|||
|
|
- **INSTANCE_MULTIMESH** = **2** --- The instance is a multimesh.
|
|||
|
|
|
|||
|
|
- **INSTANCE_IMMEDIATE** = **3** --- The instance is an immediate geometry.
|
|||
|
|
|
|||
|
|
- **INSTANCE_PARTICLES** = **4** --- The instance is a particle emitter.
|
|||
|
|
|
|||
|
|
- **INSTANCE_LIGHT** = **5** --- The instance is a light.
|
|||
|
|
|
|||
|
|
- **INSTANCE_REFLECTION_PROBE** = **6** --- The instance is a reflection probe.
|
|||
|
|
|
|||
|
|
- **INSTANCE_GI_PROBE** = **7** --- The instance is a GI probe.
|
|||
|
|
|
|||
|
|
- **INSTANCE_LIGHTMAP_CAPTURE** = **8** --- The instance is a lightmap capture.
|
|||
|
|
|
|||
|
|
- **INSTANCE_MAX** = **9** --- Represents the size of the :ref:`InstanceType<enum_VisualServer_InstanceType>` enum.
|
|||
|
|
|
|||
|
|
- **INSTANCE_GEOMETRY_MASK** = **30** --- A combination of the flags of geometry instances (mesh, multimesh, immediate and particles).
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _enum_VisualServer_InstanceFlags:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_INSTANCE_FLAG_USE_BAKED_LIGHT:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_INSTANCE_FLAG_DRAW_NEXT_FRAME_IF_VISIBLE:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_INSTANCE_FLAG_MAX:
|
|||
|
|
|
|||
|
|
enum **InstanceFlags**:
|
|||
|
|
|
|||
|
|
- **INSTANCE_FLAG_USE_BAKED_LIGHT** = **0** --- Allows the instance to be used in baked lighting.
|
|||
|
|
|
|||
|
|
- **INSTANCE_FLAG_DRAW_NEXT_FRAME_IF_VISIBLE** = **1** --- When set, manually requests to draw geometry on next frame.
|
|||
|
|
|
|||
|
|
- **INSTANCE_FLAG_MAX** = **2** --- Represents the size of the :ref:`InstanceFlags<enum_VisualServer_InstanceFlags>` enum.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _enum_VisualServer_ShadowCastingSetting:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_SHADOW_CASTING_SETTING_OFF:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_SHADOW_CASTING_SETTING_ON:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_SHADOW_CASTING_SETTING_DOUBLE_SIDED:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_SHADOW_CASTING_SETTING_SHADOWS_ONLY:
|
|||
|
|
|
|||
|
|
enum **ShadowCastingSetting**:
|
|||
|
|
|
|||
|
|
- **SHADOW_CASTING_SETTING_OFF** = **0** --- Disable shadows from this instance.
|
|||
|
|
|
|||
|
|
- **SHADOW_CASTING_SETTING_ON** = **1** --- Cast shadows from this instance.
|
|||
|
|
|
|||
|
|
- **SHADOW_CASTING_SETTING_DOUBLE_SIDED** = **2** --- Disable backface culling when rendering the shadow of the object. This is slightly slower but may result in more correct shadows.
|
|||
|
|
|
|||
|
|
- **SHADOW_CASTING_SETTING_SHADOWS_ONLY** = **3** --- Only render the shadows from the object. The object itself will not be drawn.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _enum_VisualServer_NinePatchAxisMode:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_NINE_PATCH_STRETCH:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_NINE_PATCH_TILE:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_NINE_PATCH_TILE_FIT:
|
|||
|
|
|
|||
|
|
enum **NinePatchAxisMode**:
|
|||
|
|
|
|||
|
|
- **NINE_PATCH_STRETCH** = **0** --- The nine patch gets stretched where needed.
|
|||
|
|
|
|||
|
|
- **NINE_PATCH_TILE** = **1** --- The nine patch gets filled with tiles where needed.
|
|||
|
|
|
|||
|
|
- **NINE_PATCH_TILE_FIT** = **2** --- The nine patch gets filled with tiles where needed and stretches them a bit if needed.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _enum_VisualServer_CanvasLightMode:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_CANVAS_LIGHT_MODE_ADD:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_CANVAS_LIGHT_MODE_SUB:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_CANVAS_LIGHT_MODE_MIX:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_CANVAS_LIGHT_MODE_MASK:
|
|||
|
|
|
|||
|
|
enum **CanvasLightMode**:
|
|||
|
|
|
|||
|
|
- **CANVAS_LIGHT_MODE_ADD** = **0** --- Adds light color additive to the canvas.
|
|||
|
|
|
|||
|
|
- **CANVAS_LIGHT_MODE_SUB** = **1** --- Adds light color subtractive to the canvas.
|
|||
|
|
|
|||
|
|
- **CANVAS_LIGHT_MODE_MIX** = **2** --- The light adds color depending on transparency.
|
|||
|
|
|
|||
|
|
- **CANVAS_LIGHT_MODE_MASK** = **3** --- The light adds color depending on mask.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _enum_VisualServer_CanvasLightShadowFilter:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_CANVAS_LIGHT_FILTER_NONE:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_CANVAS_LIGHT_FILTER_PCF3:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_CANVAS_LIGHT_FILTER_PCF5:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_CANVAS_LIGHT_FILTER_PCF7:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_CANVAS_LIGHT_FILTER_PCF9:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_CANVAS_LIGHT_FILTER_PCF13:
|
|||
|
|
|
|||
|
|
enum **CanvasLightShadowFilter**:
|
|||
|
|
|
|||
|
|
- **CANVAS_LIGHT_FILTER_NONE** = **0** --- Do not apply a filter to canvas light shadows.
|
|||
|
|
|
|||
|
|
- **CANVAS_LIGHT_FILTER_PCF3** = **1** --- Use PCF3 filtering to filter canvas light shadows.
|
|||
|
|
|
|||
|
|
- **CANVAS_LIGHT_FILTER_PCF5** = **2** --- Use PCF5 filtering to filter canvas light shadows.
|
|||
|
|
|
|||
|
|
- **CANVAS_LIGHT_FILTER_PCF7** = **3** --- Use PCF7 filtering to filter canvas light shadows.
|
|||
|
|
|
|||
|
|
- **CANVAS_LIGHT_FILTER_PCF9** = **4** --- Use PCF9 filtering to filter canvas light shadows.
|
|||
|
|
|
|||
|
|
- **CANVAS_LIGHT_FILTER_PCF13** = **5** --- Use PCF13 filtering to filter canvas light shadows.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _enum_VisualServer_CanvasOccluderPolygonCullMode:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_CANVAS_OCCLUDER_POLYGON_CULL_DISABLED:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_CANVAS_OCCLUDER_POLYGON_CULL_CLOCKWISE:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_CANVAS_OCCLUDER_POLYGON_CULL_COUNTER_CLOCKWISE:
|
|||
|
|
|
|||
|
|
enum **CanvasOccluderPolygonCullMode**:
|
|||
|
|
|
|||
|
|
- **CANVAS_OCCLUDER_POLYGON_CULL_DISABLED** = **0** --- Culling of the canvas occluder is disabled.
|
|||
|
|
|
|||
|
|
- **CANVAS_OCCLUDER_POLYGON_CULL_CLOCKWISE** = **1** --- Culling of the canvas occluder is clockwise.
|
|||
|
|
|
|||
|
|
- **CANVAS_OCCLUDER_POLYGON_CULL_COUNTER_CLOCKWISE** = **2** --- Culling of the canvas occluder is counterclockwise.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _enum_VisualServer_RenderInfo:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_INFO_OBJECTS_IN_FRAME:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_INFO_VERTICES_IN_FRAME:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_INFO_MATERIAL_CHANGES_IN_FRAME:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_INFO_SHADER_CHANGES_IN_FRAME:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_INFO_SHADER_COMPILES_IN_FRAME:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_INFO_SURFACE_CHANGES_IN_FRAME:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_INFO_DRAW_CALLS_IN_FRAME:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_INFO_2D_ITEMS_IN_FRAME:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_INFO_2D_DRAW_CALLS_IN_FRAME:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_INFO_USAGE_VIDEO_MEM_TOTAL:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_INFO_VIDEO_MEM_USED:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_INFO_TEXTURE_MEM_USED:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_INFO_VERTEX_MEM_USED:
|
|||
|
|
|
|||
|
|
enum **RenderInfo**:
|
|||
|
|
|
|||
|
|
- **INFO_OBJECTS_IN_FRAME** = **0** --- The amount of objects in the frame.
|
|||
|
|
|
|||
|
|
- **INFO_VERTICES_IN_FRAME** = **1** --- The amount of vertices in the frame.
|
|||
|
|
|
|||
|
|
- **INFO_MATERIAL_CHANGES_IN_FRAME** = **2** --- The amount of modified materials in the frame.
|
|||
|
|
|
|||
|
|
- **INFO_SHADER_CHANGES_IN_FRAME** = **3** --- The amount of shader rebinds in the frame.
|
|||
|
|
|
|||
|
|
- **INFO_SHADER_COMPILES_IN_FRAME** = **4** --- The peak amount of shaders that have been under compilation in the frame.
|
|||
|
|
|
|||
|
|
This is useful to know when asynchronous shader compilation has finished for the current shaders on screen.
|
|||
|
|
|
|||
|
|
\ **Note:** For complete certainty, only assume there are no outstanding compilations when this value is zero for at least two frames in a row.
|
|||
|
|
|
|||
|
|
Unimplemented in the GLES2 rendering backend, always returns 0.
|
|||
|
|
|
|||
|
|
- **INFO_SURFACE_CHANGES_IN_FRAME** = **5** --- The amount of surface changes in the frame.
|
|||
|
|
|
|||
|
|
- **INFO_DRAW_CALLS_IN_FRAME** = **6** --- The amount of draw calls in frame.
|
|||
|
|
|
|||
|
|
- **INFO_2D_ITEMS_IN_FRAME** = **7** --- The amount of 2d items in the frame.
|
|||
|
|
|
|||
|
|
- **INFO_2D_DRAW_CALLS_IN_FRAME** = **8** --- The amount of 2d draw calls in frame.
|
|||
|
|
|
|||
|
|
- **INFO_USAGE_VIDEO_MEM_TOTAL** = **9** --- Unimplemented in the GLES2 and GLES3 rendering backends, always returns 0.
|
|||
|
|
|
|||
|
|
- **INFO_VIDEO_MEM_USED** = **10** --- The amount of video memory used, i.e. texture and vertex memory combined.
|
|||
|
|
|
|||
|
|
- **INFO_TEXTURE_MEM_USED** = **11** --- The amount of texture memory used.
|
|||
|
|
|
|||
|
|
- **INFO_VERTEX_MEM_USED** = **12** --- The amount of vertex memory used.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _enum_VisualServer_Features:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_FEATURE_SHADERS:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_FEATURE_MULTITHREADED:
|
|||
|
|
|
|||
|
|
enum **Features**:
|
|||
|
|
|
|||
|
|
- **FEATURE_SHADERS** = **0** --- Hardware supports shaders. This enum is currently unused in Godot 3.x.
|
|||
|
|
|
|||
|
|
- **FEATURE_MULTITHREADED** = **1** --- Hardware supports multithreading. This enum is currently unused in Godot 3.x.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _enum_VisualServer_MultimeshTransformFormat:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_MULTIMESH_TRANSFORM_2D:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_MULTIMESH_TRANSFORM_3D:
|
|||
|
|
|
|||
|
|
enum **MultimeshTransformFormat**:
|
|||
|
|
|
|||
|
|
- **MULTIMESH_TRANSFORM_2D** = **0** --- Use :ref:`Transform2D<class_Transform2D>` to store MultiMesh transform.
|
|||
|
|
|
|||
|
|
- **MULTIMESH_TRANSFORM_3D** = **1** --- Use :ref:`Transform<class_Transform>` to store MultiMesh transform.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _enum_VisualServer_MultimeshColorFormat:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_MULTIMESH_COLOR_NONE:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_MULTIMESH_COLOR_8BIT:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_MULTIMESH_COLOR_FLOAT:
|
|||
|
|
|
|||
|
|
enum **MultimeshColorFormat**:
|
|||
|
|
|
|||
|
|
- **MULTIMESH_COLOR_NONE** = **0** --- MultiMesh does not use per-instance color.
|
|||
|
|
|
|||
|
|
- **MULTIMESH_COLOR_8BIT** = **1** --- MultiMesh color uses 8 bits per component. This packs the color into a single float.
|
|||
|
|
|
|||
|
|
- **MULTIMESH_COLOR_FLOAT** = **2** --- MultiMesh color uses a float per channel.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _enum_VisualServer_MultimeshCustomDataFormat:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_MULTIMESH_CUSTOM_DATA_NONE:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_MULTIMESH_CUSTOM_DATA_8BIT:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_MULTIMESH_CUSTOM_DATA_FLOAT:
|
|||
|
|
|
|||
|
|
enum **MultimeshCustomDataFormat**:
|
|||
|
|
|
|||
|
|
- **MULTIMESH_CUSTOM_DATA_NONE** = **0** --- MultiMesh does not use custom data.
|
|||
|
|
|
|||
|
|
- **MULTIMESH_CUSTOM_DATA_8BIT** = **1** --- MultiMesh custom data uses 8 bits per component. This packs the 4-component custom data into a single float.
|
|||
|
|
|
|||
|
|
- **MULTIMESH_CUSTOM_DATA_FLOAT** = **2** --- MultiMesh custom data uses a float per component.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _enum_VisualServer_MultimeshPhysicsInterpolationQuality:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_MULTIMESH_INTERP_QUALITY_FAST:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_MULTIMESH_INTERP_QUALITY_HIGH:
|
|||
|
|
|
|||
|
|
enum **MultimeshPhysicsInterpolationQuality**:
|
|||
|
|
|
|||
|
|
- **MULTIMESH_INTERP_QUALITY_FAST** = **0** --- MultiMesh physics interpolation favours speed over quality.
|
|||
|
|
|
|||
|
|
- **MULTIMESH_INTERP_QUALITY_HIGH** = **1** --- MultiMesh physics interpolation favours quality over speed.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _enum_VisualServer_ReflectionProbeUpdateMode:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_REFLECTION_PROBE_UPDATE_ONCE:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_REFLECTION_PROBE_UPDATE_ALWAYS:
|
|||
|
|
|
|||
|
|
enum **ReflectionProbeUpdateMode**:
|
|||
|
|
|
|||
|
|
- **REFLECTION_PROBE_UPDATE_ONCE** = **0** --- Reflection probe will update reflections once and then stop.
|
|||
|
|
|
|||
|
|
- **REFLECTION_PROBE_UPDATE_ALWAYS** = **1** --- Reflection probe will update each frame. This mode is necessary to capture moving objects.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _enum_VisualServer_ParticlesDrawOrder:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_PARTICLES_DRAW_ORDER_INDEX:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_PARTICLES_DRAW_ORDER_LIFETIME:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_PARTICLES_DRAW_ORDER_VIEW_DEPTH:
|
|||
|
|
|
|||
|
|
enum **ParticlesDrawOrder**:
|
|||
|
|
|
|||
|
|
- **PARTICLES_DRAW_ORDER_INDEX** = **0** --- Draw particles in the order that they appear in the particles array.
|
|||
|
|
|
|||
|
|
- **PARTICLES_DRAW_ORDER_LIFETIME** = **1** --- Sort particles based on their lifetime.
|
|||
|
|
|
|||
|
|
- **PARTICLES_DRAW_ORDER_VIEW_DEPTH** = **2** --- Sort particles based on their distance to the camera.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _enum_VisualServer_EnvironmentBG:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_ENV_BG_CLEAR_COLOR:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_ENV_BG_COLOR:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_ENV_BG_SKY:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_ENV_BG_COLOR_SKY:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_ENV_BG_CANVAS:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_ENV_BG_KEEP:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_ENV_BG_MAX:
|
|||
|
|
|
|||
|
|
enum **EnvironmentBG**:
|
|||
|
|
|
|||
|
|
- **ENV_BG_CLEAR_COLOR** = **0** --- Use the clear color as background.
|
|||
|
|
|
|||
|
|
- **ENV_BG_COLOR** = **1** --- Use a specified color as the background.
|
|||
|
|
|
|||
|
|
- **ENV_BG_SKY** = **2** --- Use a sky resource for the background.
|
|||
|
|
|
|||
|
|
- **ENV_BG_COLOR_SKY** = **3** --- Use a custom color for background, but use a sky for shading and reflections.
|
|||
|
|
|
|||
|
|
- **ENV_BG_CANVAS** = **4** --- Use a specified canvas layer as the background. This can be useful for instantiating a 2D scene in a 3D world.
|
|||
|
|
|
|||
|
|
- **ENV_BG_KEEP** = **5** --- Do not clear the background, use whatever was rendered last frame as the background.
|
|||
|
|
|
|||
|
|
- **ENV_BG_MAX** = **7** --- Represents the size of the :ref:`EnvironmentBG<enum_VisualServer_EnvironmentBG>` enum.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _enum_VisualServer_EnvironmentDOFBlurQuality:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_ENV_DOF_BLUR_QUALITY_LOW:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_ENV_DOF_BLUR_QUALITY_MEDIUM:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_ENV_DOF_BLUR_QUALITY_HIGH:
|
|||
|
|
|
|||
|
|
enum **EnvironmentDOFBlurQuality**:
|
|||
|
|
|
|||
|
|
- **ENV_DOF_BLUR_QUALITY_LOW** = **0** --- Use lowest blur quality. Fastest, but may look bad.
|
|||
|
|
|
|||
|
|
- **ENV_DOF_BLUR_QUALITY_MEDIUM** = **1** --- Use medium blur quality.
|
|||
|
|
|
|||
|
|
- **ENV_DOF_BLUR_QUALITY_HIGH** = **2** --- Used highest blur quality. Looks the best, but is the slowest.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _enum_VisualServer_EnvironmentGlowBlendMode:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_GLOW_BLEND_MODE_ADDITIVE:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_GLOW_BLEND_MODE_SCREEN:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_GLOW_BLEND_MODE_SOFTLIGHT:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_GLOW_BLEND_MODE_REPLACE:
|
|||
|
|
|
|||
|
|
enum **EnvironmentGlowBlendMode**:
|
|||
|
|
|
|||
|
|
- **GLOW_BLEND_MODE_ADDITIVE** = **0** --- Add the effect of the glow on top of the scene.
|
|||
|
|
|
|||
|
|
- **GLOW_BLEND_MODE_SCREEN** = **1** --- Blends the glow effect with the screen. Does not get as bright as additive.
|
|||
|
|
|
|||
|
|
- **GLOW_BLEND_MODE_SOFTLIGHT** = **2** --- Produces a subtle color disturbance around objects.
|
|||
|
|
|
|||
|
|
- **GLOW_BLEND_MODE_REPLACE** = **3** --- Shows the glow effect by itself without the underlying scene.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _enum_VisualServer_EnvironmentToneMapper:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_ENV_TONE_MAPPER_LINEAR:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_ENV_TONE_MAPPER_REINHARD:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_ENV_TONE_MAPPER_FILMIC:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_ENV_TONE_MAPPER_ACES:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_ENV_TONE_MAPPER_ACES_FITTED:
|
|||
|
|
|
|||
|
|
enum **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.
|
|||
|
|
|
|||
|
|
- **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.
|
|||
|
|
|
|||
|
|
- **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_VisualServer_constant_ENV_TONE_MAPPER_REINHARD>`.
|
|||
|
|
|
|||
|
|
- **ENV_TONE_MAPPER_ACES** = **3** --- Use the legacy Godot version of the Academy Color Encoding System tonemapper. Unlike :ref:`ENV_TONE_MAPPER_ACES_FITTED<class_VisualServer_constant_ENV_TONE_MAPPER_ACES_FITTED>`, this version of ACES does not handle bright lighting in a physically accurate way. ACES typically has a more contrasted output compared to :ref:`ENV_TONE_MAPPER_REINHARD<class_VisualServer_constant_ENV_TONE_MAPPER_REINHARD>` and :ref:`ENV_TONE_MAPPER_FILMIC<class_VisualServer_constant_ENV_TONE_MAPPER_FILMIC>`.
|
|||
|
|
|
|||
|
|
\ **Note:** This tonemapping operator will be removed in Godot 4.0 in favor of the more accurate :ref:`ENV_TONE_MAPPER_ACES_FITTED<class_VisualServer_constant_ENV_TONE_MAPPER_ACES_FITTED>`.
|
|||
|
|
|
|||
|
|
- **ENV_TONE_MAPPER_ACES_FITTED** = **4** --- 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<class_VisualServer_constant_ENV_TONE_MAPPER_REINHARD>` and :ref:`ENV_TONE_MAPPER_FILMIC<class_VisualServer_constant_ENV_TONE_MAPPER_FILMIC>`.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _enum_VisualServer_EnvironmentSSAOQuality:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_ENV_SSAO_QUALITY_LOW:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_ENV_SSAO_QUALITY_MEDIUM:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_ENV_SSAO_QUALITY_HIGH:
|
|||
|
|
|
|||
|
|
enum **EnvironmentSSAOQuality**:
|
|||
|
|
|
|||
|
|
- **ENV_SSAO_QUALITY_LOW** = **0** --- Lowest quality of screen space ambient occlusion.
|
|||
|
|
|
|||
|
|
- **ENV_SSAO_QUALITY_MEDIUM** = **1** --- Medium quality screen space ambient occlusion.
|
|||
|
|
|
|||
|
|
- **ENV_SSAO_QUALITY_HIGH** = **2** --- Highest quality screen space ambient occlusion.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _enum_VisualServer_EnvironmentSSAOBlur:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_ENV_SSAO_BLUR_DISABLED:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_ENV_SSAO_BLUR_1x1:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_ENV_SSAO_BLUR_2x2:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_ENV_SSAO_BLUR_3x3:
|
|||
|
|
|
|||
|
|
enum **EnvironmentSSAOBlur**:
|
|||
|
|
|
|||
|
|
- **ENV_SSAO_BLUR_DISABLED** = **0** --- Disables the blur set for SSAO. Will make SSAO look noisier.
|
|||
|
|
|
|||
|
|
- **ENV_SSAO_BLUR_1x1** = **1** --- Perform a 1x1 blur on the SSAO output.
|
|||
|
|
|
|||
|
|
- **ENV_SSAO_BLUR_2x2** = **2** --- Performs a 2x2 blur on the SSAO output.
|
|||
|
|
|
|||
|
|
- **ENV_SSAO_BLUR_3x3** = **3** --- Performs a 3x3 blur on the SSAO output. Use this for smoothest SSAO.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _enum_VisualServer_ChangedPriority:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_CHANGED_PRIORITY_ANY:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_CHANGED_PRIORITY_LOW:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_CHANGED_PRIORITY_HIGH:
|
|||
|
|
|
|||
|
|
enum **ChangedPriority**:
|
|||
|
|
|
|||
|
|
- **CHANGED_PRIORITY_ANY** = **0** --- Used to query for any changes that request a redraw, whatever the priority.
|
|||
|
|
|
|||
|
|
- **CHANGED_PRIORITY_LOW** = **1** --- Registered changes which have low priority can be optionally prevented from causing editor redraws. Examples might include dynamic shaders (typically using the ``TIME`` built-in).
|
|||
|
|
|
|||
|
|
- **CHANGED_PRIORITY_HIGH** = **2** --- Registered changes which can cause a redraw default to high priority.
|
|||
|
|
|
|||
|
|
Constants
|
|||
|
|
---------
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_NO_INDEX_ARRAY:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_ARRAY_WEIGHTS_SIZE:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_CANVAS_ITEM_Z_MIN:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_CANVAS_ITEM_Z_MAX:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_MAX_GLOW_LEVELS:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_MAX_CURSORS:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_MATERIAL_RENDER_PRIORITY_MIN:
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_constant_MATERIAL_RENDER_PRIORITY_MAX:
|
|||
|
|
|
|||
|
|
- **NO_INDEX_ARRAY** = **-1** --- Marks an error that shows that the index array is empty.
|
|||
|
|
|
|||
|
|
- **ARRAY_WEIGHTS_SIZE** = **4** --- Number of weights/bones per vertex.
|
|||
|
|
|
|||
|
|
- **CANVAS_ITEM_Z_MIN** = **-4096** --- The minimum Z-layer for canvas items.
|
|||
|
|
|
|||
|
|
- **CANVAS_ITEM_Z_MAX** = **4096** --- The maximum Z-layer for canvas items.
|
|||
|
|
|
|||
|
|
- **MAX_GLOW_LEVELS** = **7** --- Max number of glow levels that can be used with glow post-process effect.
|
|||
|
|
|
|||
|
|
- **MAX_CURSORS** = **8** --- Unused enum in Godot 3.x.
|
|||
|
|
|
|||
|
|
- **MATERIAL_RENDER_PRIORITY_MIN** = **-128** --- The minimum renderpriority of all materials.
|
|||
|
|
|
|||
|
|
- **MATERIAL_RENDER_PRIORITY_MAX** = **127** --- The maximum renderpriority of all materials.
|
|||
|
|
|
|||
|
|
Property Descriptions
|
|||
|
|
---------------------
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_property_render_loop_enabled:
|
|||
|
|
|
|||
|
|
- :ref:`bool<class_bool>` **render_loop_enabled**
|
|||
|
|
|
|||
|
|
+----------+--------------------------------+
|
|||
|
|
| *Setter* | set_render_loop_enabled(value) |
|
|||
|
|
+----------+--------------------------------+
|
|||
|
|
| *Getter* | is_render_loop_enabled() |
|
|||
|
|
+----------+--------------------------------+
|
|||
|
|
|
|||
|
|
If ``false``, disables rendering completely, but the engine logic is still being processed. You can call :ref:`force_draw<class_VisualServer_method_force_draw>` to draw a frame even with rendering disabled.
|
|||
|
|
|
|||
|
|
Method Descriptions
|
|||
|
|
-------------------
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_black_bars_set_images:
|
|||
|
|
|
|||
|
|
- void **black_bars_set_images** **(** :ref:`RID<class_RID>` left, :ref:`RID<class_RID>` top, :ref:`RID<class_RID>` right, :ref:`RID<class_RID>` bottom **)**
|
|||
|
|
|
|||
|
|
Sets images to be rendered in the window margin.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_black_bars_set_margins:
|
|||
|
|
|
|||
|
|
- void **black_bars_set_margins** **(** :ref:`int<class_int>` left, :ref:`int<class_int>` top, :ref:`int<class_int>` right, :ref:`int<class_int>` bottom **)**
|
|||
|
|
|
|||
|
|
Sets margin size, where black bars (or images, if :ref:`black_bars_set_images<class_VisualServer_method_black_bars_set_images>` was used) are rendered.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_camera_create:
|
|||
|
|
|
|||
|
|
- :ref:`RID<class_RID>` **camera_create** **(** **)**
|
|||
|
|
|
|||
|
|
Creates a camera and adds it to the VisualServer. It can be accessed with the RID that is returned. This RID will be used in all ``camera_*`` VisualServer functions.
|
|||
|
|
|
|||
|
|
Once finished with your RID, you will want to free the RID using the VisualServer's :ref:`free_rid<class_VisualServer_method_free_rid>` static method.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_camera_reset_physics_interpolation:
|
|||
|
|
|
|||
|
|
- void **camera_reset_physics_interpolation** **(** :ref:`RID<class_RID>` camera **)**
|
|||
|
|
|
|||
|
|
Prevents physics interpolation for the current physics tick.
|
|||
|
|
|
|||
|
|
This is useful when moving a :ref:`Camera<class_Camera>` to a new location, to give an instantaneous change rather than interpolation from the previous location.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_camera_set_cull_mask:
|
|||
|
|
|
|||
|
|
- void **camera_set_cull_mask** **(** :ref:`RID<class_RID>` camera, :ref:`int<class_int>` layers **)**
|
|||
|
|
|
|||
|
|
Sets the cull mask associated with this camera. The cull mask describes which 3D layers are rendered by this camera. Equivalent to :ref:`Camera.cull_mask<class_Camera_property_cull_mask>`.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_camera_set_environment:
|
|||
|
|
|
|||
|
|
- void **camera_set_environment** **(** :ref:`RID<class_RID>` camera, :ref:`RID<class_RID>` env **)**
|
|||
|
|
|
|||
|
|
Sets the environment used by this camera. Equivalent to :ref:`Camera.environment<class_Camera_property_environment>`.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_camera_set_frustum:
|
|||
|
|
|
|||
|
|
- void **camera_set_frustum** **(** :ref:`RID<class_RID>` camera, :ref:`float<class_float>` size, :ref:`Vector2<class_Vector2>` offset, :ref:`float<class_float>` z_near, :ref:`float<class_float>` z_far **)**
|
|||
|
|
|
|||
|
|
Sets camera to use frustum projection. This mode allows adjusting the ``offset`` argument to create "tilted frustum" effects.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_camera_set_interpolated:
|
|||
|
|
|
|||
|
|
- void **camera_set_interpolated** **(** :ref:`RID<class_RID>` camera, :ref:`bool<class_bool>` interpolated **)**
|
|||
|
|
|
|||
|
|
Turns on and off physics interpolation for the :ref:`Camera<class_Camera>`.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_camera_set_orthogonal:
|
|||
|
|
|
|||
|
|
- void **camera_set_orthogonal** **(** :ref:`RID<class_RID>` camera, :ref:`float<class_float>` size, :ref:`float<class_float>` z_near, :ref:`float<class_float>` z_far **)**
|
|||
|
|
|
|||
|
|
Sets camera to use orthogonal projection, also known as orthographic projection. Objects remain the same size on the screen no matter how far away they are.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_camera_set_perspective:
|
|||
|
|
|
|||
|
|
- void **camera_set_perspective** **(** :ref:`RID<class_RID>` camera, :ref:`float<class_float>` fovy_degrees, :ref:`float<class_float>` z_near, :ref:`float<class_float>` z_far **)**
|
|||
|
|
|
|||
|
|
Sets camera to use perspective projection. Objects on the screen becomes smaller when they are far away.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_camera_set_transform:
|
|||
|
|
|
|||
|
|
- void **camera_set_transform** **(** :ref:`RID<class_RID>` camera, :ref:`Transform<class_Transform>` transform **)**
|
|||
|
|
|
|||
|
|
Sets :ref:`Transform<class_Transform>` of camera.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_camera_set_use_vertical_aspect:
|
|||
|
|
|
|||
|
|
- void **camera_set_use_vertical_aspect** **(** :ref:`RID<class_RID>` camera, :ref:`bool<class_bool>` enable **)**
|
|||
|
|
|
|||
|
|
If ``true``, preserves the horizontal aspect ratio which is equivalent to :ref:`Camera.KEEP_WIDTH<class_Camera_constant_KEEP_WIDTH>`. If ``false``, preserves the vertical aspect ratio which is equivalent to :ref:`Camera.KEEP_HEIGHT<class_Camera_constant_KEEP_HEIGHT>`.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_canvas_create:
|
|||
|
|
|
|||
|
|
- :ref:`RID<class_RID>` **canvas_create** **(** **)**
|
|||
|
|
|
|||
|
|
Creates a canvas and returns the assigned :ref:`RID<class_RID>`. It can be accessed with the RID that is returned. This RID will be used in all ``canvas_*`` VisualServer functions.
|
|||
|
|
|
|||
|
|
Once finished with your RID, you will want to free the RID using the VisualServer's :ref:`free_rid<class_VisualServer_method_free_rid>` static method.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_canvas_item_add_circle:
|
|||
|
|
|
|||
|
|
- void **canvas_item_add_circle** **(** :ref:`RID<class_RID>` item, :ref:`Vector2<class_Vector2>` pos, :ref:`float<class_float>` radius, :ref:`Color<class_Color>` color **)**
|
|||
|
|
|
|||
|
|
Adds a circle command to the :ref:`CanvasItem<class_CanvasItem>`'s draw commands.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_canvas_item_add_clip_ignore:
|
|||
|
|
|
|||
|
|
- void **canvas_item_add_clip_ignore** **(** :ref:`RID<class_RID>` item, :ref:`bool<class_bool>` ignore **)**
|
|||
|
|
|
|||
|
|
If ignore is ``true``, the VisualServer does not perform clipping.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_canvas_item_add_line:
|
|||
|
|
|
|||
|
|
- void **canvas_item_add_line** **(** :ref:`RID<class_RID>` item, :ref:`Vector2<class_Vector2>` from, :ref:`Vector2<class_Vector2>` to, :ref:`Color<class_Color>` color, :ref:`float<class_float>` width=1.0, :ref:`bool<class_bool>` antialiased=false **)**
|
|||
|
|
|
|||
|
|
Adds a line command to the :ref:`CanvasItem<class_CanvasItem>`'s draw commands.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_canvas_item_add_mesh:
|
|||
|
|
|
|||
|
|
- void **canvas_item_add_mesh** **(** :ref:`RID<class_RID>` item, :ref:`RID<class_RID>` mesh, :ref:`Transform2D<class_Transform2D>` transform=Transform2D( 1, 0, 0, 1, 0, 0 ), :ref:`Color<class_Color>` modulate=Color( 1, 1, 1, 1 ), :ref:`RID<class_RID>` texture, :ref:`RID<class_RID>` normal_map **)**
|
|||
|
|
|
|||
|
|
Adds a mesh command to the :ref:`CanvasItem<class_CanvasItem>`'s draw commands.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_canvas_item_add_multimesh:
|
|||
|
|
|
|||
|
|
- void **canvas_item_add_multimesh** **(** :ref:`RID<class_RID>` item, :ref:`RID<class_RID>` mesh, :ref:`RID<class_RID>` texture, :ref:`RID<class_RID>` normal_map **)**
|
|||
|
|
|
|||
|
|
Adds a :ref:`MultiMesh<class_MultiMesh>` to the :ref:`CanvasItem<class_CanvasItem>`'s draw commands. Only affects its aabb at the moment.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_canvas_item_add_nine_patch:
|
|||
|
|
|
|||
|
|
- void **canvas_item_add_nine_patch** **(** :ref:`RID<class_RID>` item, :ref:`Rect2<class_Rect2>` rect, :ref:`Rect2<class_Rect2>` source, :ref:`RID<class_RID>` texture, :ref:`Vector2<class_Vector2>` topleft, :ref:`Vector2<class_Vector2>` bottomright, :ref:`NinePatchAxisMode<enum_VisualServer_NinePatchAxisMode>` x_axis_mode=0, :ref:`NinePatchAxisMode<enum_VisualServer_NinePatchAxisMode>` y_axis_mode=0, :ref:`bool<class_bool>` draw_center=true, :ref:`Color<class_Color>` modulate=Color( 1, 1, 1, 1 ), :ref:`RID<class_RID>` normal_map **)**
|
|||
|
|
|
|||
|
|
Adds a nine patch image to the :ref:`CanvasItem<class_CanvasItem>`'s draw commands.
|
|||
|
|
|
|||
|
|
See :ref:`NinePatchRect<class_NinePatchRect>` for more explanation.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_canvas_item_add_particles:
|
|||
|
|
|
|||
|
|
- void **canvas_item_add_particles** **(** :ref:`RID<class_RID>` item, :ref:`RID<class_RID>` particles, :ref:`RID<class_RID>` texture, :ref:`RID<class_RID>` normal_map **)**
|
|||
|
|
|
|||
|
|
Adds a particle system to the :ref:`CanvasItem<class_CanvasItem>`'s draw commands.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_canvas_item_add_polygon:
|
|||
|
|
|
|||
|
|
- void **canvas_item_add_polygon** **(** :ref:`RID<class_RID>` item, :ref:`PoolVector2Array<class_PoolVector2Array>` points, :ref:`PoolColorArray<class_PoolColorArray>` colors, :ref:`PoolVector2Array<class_PoolVector2Array>` uvs=PoolVector2Array( ), :ref:`RID<class_RID>` texture, :ref:`RID<class_RID>` normal_map, :ref:`bool<class_bool>` antialiased=false **)**
|
|||
|
|
|
|||
|
|
Adds a polygon to the :ref:`CanvasItem<class_CanvasItem>`'s draw commands.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_canvas_item_add_polyline:
|
|||
|
|
|
|||
|
|
- void **canvas_item_add_polyline** **(** :ref:`RID<class_RID>` item, :ref:`PoolVector2Array<class_PoolVector2Array>` points, :ref:`PoolColorArray<class_PoolColorArray>` colors, :ref:`float<class_float>` width=1.0, :ref:`bool<class_bool>` antialiased=false **)**
|
|||
|
|
|
|||
|
|
Adds a polyline, which is a line from multiple points with a width, to the :ref:`CanvasItem<class_CanvasItem>`'s draw commands.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_canvas_item_add_primitive:
|
|||
|
|
|
|||
|
|
- void **canvas_item_add_primitive** **(** :ref:`RID<class_RID>` item, :ref:`PoolVector2Array<class_PoolVector2Array>` points, :ref:`PoolColorArray<class_PoolColorArray>` colors, :ref:`PoolVector2Array<class_PoolVector2Array>` uvs, :ref:`RID<class_RID>` texture, :ref:`float<class_float>` width=1.0, :ref:`RID<class_RID>` normal_map **)**
|
|||
|
|
|
|||
|
|
Adds a primitive to the :ref:`CanvasItem<class_CanvasItem>`'s draw commands.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_canvas_item_add_rect:
|
|||
|
|
|
|||
|
|
- void **canvas_item_add_rect** **(** :ref:`RID<class_RID>` item, :ref:`Rect2<class_Rect2>` rect, :ref:`Color<class_Color>` color **)**
|
|||
|
|
|
|||
|
|
Adds a rectangle to the :ref:`CanvasItem<class_CanvasItem>`'s draw commands.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_canvas_item_add_set_transform:
|
|||
|
|
|
|||
|
|
- void **canvas_item_add_set_transform** **(** :ref:`RID<class_RID>` item, :ref:`Transform2D<class_Transform2D>` transform **)**
|
|||
|
|
|
|||
|
|
Adds a :ref:`Transform2D<class_Transform2D>` command to the :ref:`CanvasItem<class_CanvasItem>`'s draw commands.
|
|||
|
|
|
|||
|
|
This sets the extra_matrix uniform when executed. This affects the later commands of the canvas item.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_canvas_item_add_texture_rect:
|
|||
|
|
|
|||
|
|
- void **canvas_item_add_texture_rect** **(** :ref:`RID<class_RID>` item, :ref:`Rect2<class_Rect2>` rect, :ref:`RID<class_RID>` texture, :ref:`bool<class_bool>` tile=false, :ref:`Color<class_Color>` modulate=Color( 1, 1, 1, 1 ), :ref:`bool<class_bool>` transpose=false, :ref:`RID<class_RID>` normal_map **)**
|
|||
|
|
|
|||
|
|
Adds a textured rect to the :ref:`CanvasItem<class_CanvasItem>`'s draw commands.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_canvas_item_add_texture_rect_region:
|
|||
|
|
|
|||
|
|
- void **canvas_item_add_texture_rect_region** **(** :ref:`RID<class_RID>` item, :ref:`Rect2<class_Rect2>` rect, :ref:`RID<class_RID>` texture, :ref:`Rect2<class_Rect2>` src_rect, :ref:`Color<class_Color>` modulate=Color( 1, 1, 1, 1 ), :ref:`bool<class_bool>` transpose=false, :ref:`RID<class_RID>` normal_map, :ref:`bool<class_bool>` clip_uv=true **)**
|
|||
|
|
|
|||
|
|
Adds a texture rect with region setting to the :ref:`CanvasItem<class_CanvasItem>`'s draw commands.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_canvas_item_add_triangle_array:
|
|||
|
|
|
|||
|
|
- void **canvas_item_add_triangle_array** **(** :ref:`RID<class_RID>` item, :ref:`PoolIntArray<class_PoolIntArray>` indices, :ref:`PoolVector2Array<class_PoolVector2Array>` points, :ref:`PoolColorArray<class_PoolColorArray>` colors, :ref:`PoolVector2Array<class_PoolVector2Array>` uvs=PoolVector2Array( ), :ref:`PoolIntArray<class_PoolIntArray>` bones=PoolIntArray( ), :ref:`PoolRealArray<class_PoolRealArray>` weights=PoolRealArray( ), :ref:`RID<class_RID>` texture, :ref:`int<class_int>` count=-1, :ref:`RID<class_RID>` normal_map, :ref:`bool<class_bool>` antialiased=false, :ref:`bool<class_bool>` antialiasing_use_indices=false **)**
|
|||
|
|
|
|||
|
|
Adds a triangle array to the :ref:`CanvasItem<class_CanvasItem>`'s draw commands.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_canvas_item_clear:
|
|||
|
|
|
|||
|
|
- void **canvas_item_clear** **(** :ref:`RID<class_RID>` item **)**
|
|||
|
|
|
|||
|
|
Clears the :ref:`CanvasItem<class_CanvasItem>` and removes all commands in it.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_canvas_item_create:
|
|||
|
|
|
|||
|
|
- :ref:`RID<class_RID>` **canvas_item_create** **(** **)**
|
|||
|
|
|
|||
|
|
Creates a new :ref:`CanvasItem<class_CanvasItem>` and returns its :ref:`RID<class_RID>`. It can be accessed with the RID that is returned. This RID will be used in all ``canvas_item_*`` VisualServer functions.
|
|||
|
|
|
|||
|
|
Once finished with your RID, you will want to free the RID using the VisualServer's :ref:`free_rid<class_VisualServer_method_free_rid>` static method.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_canvas_item_set_clip:
|
|||
|
|
|
|||
|
|
- void **canvas_item_set_clip** **(** :ref:`RID<class_RID>` item, :ref:`bool<class_bool>` clip **)**
|
|||
|
|
|
|||
|
|
Sets clipping for the :ref:`CanvasItem<class_CanvasItem>`.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_canvas_item_set_copy_to_backbuffer:
|
|||
|
|
|
|||
|
|
- void **canvas_item_set_copy_to_backbuffer** **(** :ref:`RID<class_RID>` item, :ref:`bool<class_bool>` enabled, :ref:`Rect2<class_Rect2>` rect **)**
|
|||
|
|
|
|||
|
|
Sets the :ref:`CanvasItem<class_CanvasItem>` to copy a rect to the backbuffer.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_canvas_item_set_custom_rect:
|
|||
|
|
|
|||
|
|
- void **canvas_item_set_custom_rect** **(** :ref:`RID<class_RID>` item, :ref:`bool<class_bool>` use_custom_rect, :ref:`Rect2<class_Rect2>` rect=Rect2( 0, 0, 0, 0 ) **)**
|
|||
|
|
|
|||
|
|
Defines a custom drawing rectangle for the :ref:`CanvasItem<class_CanvasItem>`.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_canvas_item_set_distance_field_mode:
|
|||
|
|
|
|||
|
|
- void **canvas_item_set_distance_field_mode** **(** :ref:`RID<class_RID>` item, :ref:`bool<class_bool>` enabled **)**
|
|||
|
|
|
|||
|
|
Enables the use of distance fields for GUI elements that are rendering distance field based fonts.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_canvas_item_set_draw_behind_parent:
|
|||
|
|
|
|||
|
|
- void **canvas_item_set_draw_behind_parent** **(** :ref:`RID<class_RID>` item, :ref:`bool<class_bool>` enabled **)**
|
|||
|
|
|
|||
|
|
Sets :ref:`CanvasItem<class_CanvasItem>` to be drawn behind its parent.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_canvas_item_set_draw_index:
|
|||
|
|
|
|||
|
|
- void **canvas_item_set_draw_index** **(** :ref:`RID<class_RID>` item, :ref:`int<class_int>` index **)**
|
|||
|
|
|
|||
|
|
Sets the index for the :ref:`CanvasItem<class_CanvasItem>`.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_canvas_item_set_light_mask:
|
|||
|
|
|
|||
|
|
- void **canvas_item_set_light_mask** **(** :ref:`RID<class_RID>` item, :ref:`int<class_int>` mask **)**
|
|||
|
|
|
|||
|
|
The light mask. See :ref:`LightOccluder2D<class_LightOccluder2D>` for more information on light masks.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_canvas_item_set_material:
|
|||
|
|
|
|||
|
|
- void **canvas_item_set_material** **(** :ref:`RID<class_RID>` item, :ref:`RID<class_RID>` material **)**
|
|||
|
|
|
|||
|
|
Sets a new material to the :ref:`CanvasItem<class_CanvasItem>`.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_canvas_item_set_modulate:
|
|||
|
|
|
|||
|
|
- void **canvas_item_set_modulate** **(** :ref:`RID<class_RID>` item, :ref:`Color<class_Color>` color **)**
|
|||
|
|
|
|||
|
|
Sets the color that modulates the :ref:`CanvasItem<class_CanvasItem>` and its children.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_canvas_item_set_parent:
|
|||
|
|
|
|||
|
|
- void **canvas_item_set_parent** **(** :ref:`RID<class_RID>` item, :ref:`RID<class_RID>` parent **)**
|
|||
|
|
|
|||
|
|
Sets the parent for the :ref:`CanvasItem<class_CanvasItem>`. The parent can be another canvas item, or it can be the root canvas that is attached to the viewport.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_canvas_item_set_self_modulate:
|
|||
|
|
|
|||
|
|
- void **canvas_item_set_self_modulate** **(** :ref:`RID<class_RID>` item, :ref:`Color<class_Color>` color **)**
|
|||
|
|
|
|||
|
|
Sets the color that modulates the :ref:`CanvasItem<class_CanvasItem>` without children.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_canvas_item_set_sort_children_by_y:
|
|||
|
|
|
|||
|
|
- void **canvas_item_set_sort_children_by_y** **(** :ref:`RID<class_RID>` item, :ref:`bool<class_bool>` enabled **)**
|
|||
|
|
|
|||
|
|
Sets if :ref:`CanvasItem<class_CanvasItem>`'s children should be sorted by y-position.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_canvas_item_set_transform:
|
|||
|
|
|
|||
|
|
- void **canvas_item_set_transform** **(** :ref:`RID<class_RID>` item, :ref:`Transform2D<class_Transform2D>` transform **)**
|
|||
|
|
|
|||
|
|
Sets the :ref:`CanvasItem<class_CanvasItem>`'s :ref:`Transform2D<class_Transform2D>`.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_canvas_item_set_use_parent_material:
|
|||
|
|
|
|||
|
|
- void **canvas_item_set_use_parent_material** **(** :ref:`RID<class_RID>` item, :ref:`bool<class_bool>` enabled **)**
|
|||
|
|
|
|||
|
|
Sets if the :ref:`CanvasItem<class_CanvasItem>` uses its parent's material.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_canvas_item_set_visible:
|
|||
|
|
|
|||
|
|
- void **canvas_item_set_visible** **(** :ref:`RID<class_RID>` item, :ref:`bool<class_bool>` visible **)**
|
|||
|
|
|
|||
|
|
Sets if the canvas item (including its children) is visible.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_canvas_item_set_z_as_relative_to_parent:
|
|||
|
|
|
|||
|
|
- void **canvas_item_set_z_as_relative_to_parent** **(** :ref:`RID<class_RID>` item, :ref:`bool<class_bool>` enabled **)**
|
|||
|
|
|
|||
|
|
If this is enabled, the Z index of the parent will be added to the children's Z index.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_canvas_item_set_z_index:
|
|||
|
|
|
|||
|
|
- void **canvas_item_set_z_index** **(** :ref:`RID<class_RID>` item, :ref:`int<class_int>` z_index **)**
|
|||
|
|
|
|||
|
|
Sets the :ref:`CanvasItem<class_CanvasItem>`'s Z index, i.e. its draw order (lower indexes are drawn first).
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_canvas_light_attach_to_canvas:
|
|||
|
|
|
|||
|
|
- void **canvas_light_attach_to_canvas** **(** :ref:`RID<class_RID>` light, :ref:`RID<class_RID>` canvas **)**
|
|||
|
|
|
|||
|
|
Attaches the canvas light to the canvas. Removes it from its previous canvas.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_canvas_light_create:
|
|||
|
|
|
|||
|
|
- :ref:`RID<class_RID>` **canvas_light_create** **(** **)**
|
|||
|
|
|
|||
|
|
Creates a canvas light and adds it to the VisualServer. It can be accessed with the RID that is returned. This RID will be used in all ``canvas_light_*`` VisualServer functions.
|
|||
|
|
|
|||
|
|
Once finished with your RID, you will want to free the RID using the VisualServer's :ref:`free_rid<class_VisualServer_method_free_rid>` static method.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_canvas_light_occluder_attach_to_canvas:
|
|||
|
|
|
|||
|
|
- void **canvas_light_occluder_attach_to_canvas** **(** :ref:`RID<class_RID>` occluder, :ref:`RID<class_RID>` canvas **)**
|
|||
|
|
|
|||
|
|
Attaches a light occluder to the canvas. Removes it from its previous canvas.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_canvas_light_occluder_create:
|
|||
|
|
|
|||
|
|
- :ref:`RID<class_RID>` **canvas_light_occluder_create** **(** **)**
|
|||
|
|
|
|||
|
|
Creates a light occluder and adds it to the VisualServer. It can be accessed with the RID that is returned. This RID will be used in all ``canvas_light_ocluder_*`` VisualServer functions.
|
|||
|
|
|
|||
|
|
Once finished with your RID, you will want to free the RID using the VisualServer's :ref:`free_rid<class_VisualServer_method_free_rid>` static method.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_canvas_light_occluder_set_enabled:
|
|||
|
|
|
|||
|
|
- void **canvas_light_occluder_set_enabled** **(** :ref:`RID<class_RID>` occluder, :ref:`bool<class_bool>` enabled **)**
|
|||
|
|
|
|||
|
|
Enables or disables light occluder.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_canvas_light_occluder_set_light_mask:
|
|||
|
|
|
|||
|
|
- void **canvas_light_occluder_set_light_mask** **(** :ref:`RID<class_RID>` occluder, :ref:`int<class_int>` mask **)**
|
|||
|
|
|
|||
|
|
The light mask. See :ref:`LightOccluder2D<class_LightOccluder2D>` for more information on light masks.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_canvas_light_occluder_set_polygon:
|
|||
|
|
|
|||
|
|
- void **canvas_light_occluder_set_polygon** **(** :ref:`RID<class_RID>` occluder, :ref:`RID<class_RID>` polygon **)**
|
|||
|
|
|
|||
|
|
Sets a light occluder's polygon.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_canvas_light_occluder_set_transform:
|
|||
|
|
|
|||
|
|
- void **canvas_light_occluder_set_transform** **(** :ref:`RID<class_RID>` occluder, :ref:`Transform2D<class_Transform2D>` transform **)**
|
|||
|
|
|
|||
|
|
Sets a light occluder's :ref:`Transform2D<class_Transform2D>`.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_canvas_light_set_color:
|
|||
|
|
|
|||
|
|
- void **canvas_light_set_color** **(** :ref:`RID<class_RID>` light, :ref:`Color<class_Color>` color **)**
|
|||
|
|
|
|||
|
|
Sets the color for a light.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_canvas_light_set_enabled:
|
|||
|
|
|
|||
|
|
- void **canvas_light_set_enabled** **(** :ref:`RID<class_RID>` light, :ref:`bool<class_bool>` enabled **)**
|
|||
|
|
|
|||
|
|
Enables or disables a canvas light.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_canvas_light_set_energy:
|
|||
|
|
|
|||
|
|
- void **canvas_light_set_energy** **(** :ref:`RID<class_RID>` light, :ref:`float<class_float>` energy **)**
|
|||
|
|
|
|||
|
|
Sets a canvas light's energy.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_canvas_light_set_height:
|
|||
|
|
|
|||
|
|
- void **canvas_light_set_height** **(** :ref:`RID<class_RID>` light, :ref:`float<class_float>` height **)**
|
|||
|
|
|
|||
|
|
Sets a canvas light's height.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_canvas_light_set_item_cull_mask:
|
|||
|
|
|
|||
|
|
- void **canvas_light_set_item_cull_mask** **(** :ref:`RID<class_RID>` light, :ref:`int<class_int>` mask **)**
|
|||
|
|
|
|||
|
|
The light mask. See :ref:`LightOccluder2D<class_LightOccluder2D>` for more information on light masks.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_canvas_light_set_item_shadow_cull_mask:
|
|||
|
|
|
|||
|
|
- void **canvas_light_set_item_shadow_cull_mask** **(** :ref:`RID<class_RID>` light, :ref:`int<class_int>` mask **)**
|
|||
|
|
|
|||
|
|
The binary mask used to determine which layers this canvas light's shadows affects. See :ref:`LightOccluder2D<class_LightOccluder2D>` for more information on light masks.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_canvas_light_set_layer_range:
|
|||
|
|
|
|||
|
|
- void **canvas_light_set_layer_range** **(** :ref:`RID<class_RID>` light, :ref:`int<class_int>` min_layer, :ref:`int<class_int>` max_layer **)**
|
|||
|
|
|
|||
|
|
The layer range that gets rendered with this light.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_canvas_light_set_mode:
|
|||
|
|
|
|||
|
|
- void **canvas_light_set_mode** **(** :ref:`RID<class_RID>` light, :ref:`CanvasLightMode<enum_VisualServer_CanvasLightMode>` mode **)**
|
|||
|
|
|
|||
|
|
The mode of the light, see :ref:`CanvasLightMode<enum_VisualServer_CanvasLightMode>` constants.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_canvas_light_set_scale:
|
|||
|
|
|
|||
|
|
- void **canvas_light_set_scale** **(** :ref:`RID<class_RID>` light, :ref:`float<class_float>` scale **)**
|
|||
|
|
|
|||
|
|
Sets the texture's scale factor of the light. Equivalent to :ref:`Light2D.texture_scale<class_Light2D_property_texture_scale>`.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_canvas_light_set_shadow_buffer_size:
|
|||
|
|
|
|||
|
|
- void **canvas_light_set_shadow_buffer_size** **(** :ref:`RID<class_RID>` light, :ref:`int<class_int>` size **)**
|
|||
|
|
|
|||
|
|
Sets the width of the shadow buffer, size gets scaled to the next power of two for this.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_canvas_light_set_shadow_color:
|
|||
|
|
|
|||
|
|
- void **canvas_light_set_shadow_color** **(** :ref:`RID<class_RID>` light, :ref:`Color<class_Color>` color **)**
|
|||
|
|
|
|||
|
|
Sets the color of the canvas light's shadow.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_canvas_light_set_shadow_enabled:
|
|||
|
|
|
|||
|
|
- void **canvas_light_set_shadow_enabled** **(** :ref:`RID<class_RID>` light, :ref:`bool<class_bool>` enabled **)**
|
|||
|
|
|
|||
|
|
Enables or disables the canvas light's shadow.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_canvas_light_set_shadow_filter:
|
|||
|
|
|
|||
|
|
- void **canvas_light_set_shadow_filter** **(** :ref:`RID<class_RID>` light, :ref:`CanvasLightShadowFilter<enum_VisualServer_CanvasLightShadowFilter>` filter **)**
|
|||
|
|
|
|||
|
|
Sets the canvas light's shadow's filter, see :ref:`CanvasLightShadowFilter<enum_VisualServer_CanvasLightShadowFilter>` constants.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_canvas_light_set_shadow_gradient_length:
|
|||
|
|
|
|||
|
|
- void **canvas_light_set_shadow_gradient_length** **(** :ref:`RID<class_RID>` light, :ref:`float<class_float>` length **)**
|
|||
|
|
|
|||
|
|
Sets the length of the shadow's gradient.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_canvas_light_set_shadow_smooth:
|
|||
|
|
|
|||
|
|
- void **canvas_light_set_shadow_smooth** **(** :ref:`RID<class_RID>` light, :ref:`float<class_float>` smooth **)**
|
|||
|
|
|
|||
|
|
Smoothens the shadow. The lower, the smoother.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_canvas_light_set_texture:
|
|||
|
|
|
|||
|
|
- void **canvas_light_set_texture** **(** :ref:`RID<class_RID>` light, :ref:`RID<class_RID>` texture **)**
|
|||
|
|
|
|||
|
|
Sets texture to be used by light. Equivalent to :ref:`Light2D.texture<class_Light2D_property_texture>`.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_canvas_light_set_texture_offset:
|
|||
|
|
|
|||
|
|
- void **canvas_light_set_texture_offset** **(** :ref:`RID<class_RID>` light, :ref:`Vector2<class_Vector2>` offset **)**
|
|||
|
|
|
|||
|
|
Sets the offset of the light's texture. Equivalent to :ref:`Light2D.offset<class_Light2D_property_offset>`.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_canvas_light_set_transform:
|
|||
|
|
|
|||
|
|
- void **canvas_light_set_transform** **(** :ref:`RID<class_RID>` light, :ref:`Transform2D<class_Transform2D>` transform **)**
|
|||
|
|
|
|||
|
|
Sets the canvas light's :ref:`Transform2D<class_Transform2D>`.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_canvas_light_set_z_range:
|
|||
|
|
|
|||
|
|
- void **canvas_light_set_z_range** **(** :ref:`RID<class_RID>` light, :ref:`int<class_int>` min_z, :ref:`int<class_int>` max_z **)**
|
|||
|
|
|
|||
|
|
Sets the Z range of objects that will be affected by this light. Equivalent to :ref:`Light2D.range_z_min<class_Light2D_property_range_z_min>` and :ref:`Light2D.range_z_max<class_Light2D_property_range_z_max>`.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_canvas_occluder_polygon_create:
|
|||
|
|
|
|||
|
|
- :ref:`RID<class_RID>` **canvas_occluder_polygon_create** **(** **)**
|
|||
|
|
|
|||
|
|
Creates a new light occluder polygon and adds it to the VisualServer. It can be accessed with the RID that is returned. This RID will be used in all ``canvas_occluder_polygon_*`` VisualServer functions.
|
|||
|
|
|
|||
|
|
Once finished with your RID, you will want to free the RID using the VisualServer's :ref:`free_rid<class_VisualServer_method_free_rid>` static method.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_canvas_occluder_polygon_set_cull_mode:
|
|||
|
|
|
|||
|
|
- void **canvas_occluder_polygon_set_cull_mode** **(** :ref:`RID<class_RID>` occluder_polygon, :ref:`CanvasOccluderPolygonCullMode<enum_VisualServer_CanvasOccluderPolygonCullMode>` mode **)**
|
|||
|
|
|
|||
|
|
Sets an occluder polygons cull mode. See :ref:`CanvasOccluderPolygonCullMode<enum_VisualServer_CanvasOccluderPolygonCullMode>` constants.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_canvas_occluder_polygon_set_shape:
|
|||
|
|
|
|||
|
|
- void **canvas_occluder_polygon_set_shape** **(** :ref:`RID<class_RID>` occluder_polygon, :ref:`PoolVector2Array<class_PoolVector2Array>` shape, :ref:`bool<class_bool>` closed **)**
|
|||
|
|
|
|||
|
|
Sets the shape of the occluder polygon.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_canvas_occluder_polygon_set_shape_as_lines:
|
|||
|
|
|
|||
|
|
- void **canvas_occluder_polygon_set_shape_as_lines** **(** :ref:`RID<class_RID>` occluder_polygon, :ref:`PoolVector2Array<class_PoolVector2Array>` shape **)**
|
|||
|
|
|
|||
|
|
Sets the shape of the occluder polygon as lines.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_canvas_set_item_mirroring:
|
|||
|
|
|
|||
|
|
- void **canvas_set_item_mirroring** **(** :ref:`RID<class_RID>` canvas, :ref:`RID<class_RID>` item, :ref:`Vector2<class_Vector2>` mirroring **)**
|
|||
|
|
|
|||
|
|
A copy of the canvas item will be drawn with a local offset of the mirroring :ref:`Vector2<class_Vector2>`.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_canvas_set_modulate:
|
|||
|
|
|
|||
|
|
- void **canvas_set_modulate** **(** :ref:`RID<class_RID>` canvas, :ref:`Color<class_Color>` color **)**
|
|||
|
|
|
|||
|
|
Modulates all colors in the given canvas.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_directional_light_create:
|
|||
|
|
|
|||
|
|
- :ref:`RID<class_RID>` **directional_light_create** **(** **)**
|
|||
|
|
|
|||
|
|
Creates a directional light and adds it to the VisualServer. It can be accessed with the RID that is returned. This RID can be used in most ``light_*`` VisualServer functions.
|
|||
|
|
|
|||
|
|
Once finished with your RID, you will want to free the RID using the VisualServer's :ref:`free_rid<class_VisualServer_method_free_rid>` static method.
|
|||
|
|
|
|||
|
|
To place in a scene, attach this directional light to an instance using :ref:`instance_set_base<class_VisualServer_method_instance_set_base>` using the returned RID.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_draw:
|
|||
|
|
|
|||
|
|
- void **draw** **(** :ref:`bool<class_bool>` swap_buffers=true, :ref:`float<class_float>` frame_step=0.0 **)**
|
|||
|
|
|
|||
|
|
Draws a frame. *This method is deprecated*, please use :ref:`force_draw<class_VisualServer_method_force_draw>` instead.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_environment_create:
|
|||
|
|
|
|||
|
|
- :ref:`RID<class_RID>` **environment_create** **(** **)**
|
|||
|
|
|
|||
|
|
Creates an environment and adds it to the VisualServer. It can be accessed with the RID that is returned. This RID will be used in all ``environment_*`` VisualServer functions.
|
|||
|
|
|
|||
|
|
Once finished with your RID, you will want to free the RID using the VisualServer's :ref:`free_rid<class_VisualServer_method_free_rid>` static method.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_environment_set_adjustment:
|
|||
|
|
|
|||
|
|
- void **environment_set_adjustment** **(** :ref:`RID<class_RID>` env, :ref:`bool<class_bool>` enable, :ref:`float<class_float>` brightness, :ref:`float<class_float>` contrast, :ref:`float<class_float>` saturation, :ref:`RID<class_RID>` ramp **)**
|
|||
|
|
|
|||
|
|
Sets the values to be used with the "Adjustment" post-process effect. See :ref:`Environment<class_Environment>` for more details.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_environment_set_ambient_light:
|
|||
|
|
|
|||
|
|
- void **environment_set_ambient_light** **(** :ref:`RID<class_RID>` env, :ref:`Color<class_Color>` color, :ref:`float<class_float>` energy=1.0, :ref:`float<class_float>` sky_contibution=0.0 **)**
|
|||
|
|
|
|||
|
|
Sets the ambient light parameters. See :ref:`Environment<class_Environment>` for more details.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_environment_set_background:
|
|||
|
|
|
|||
|
|
- void **environment_set_background** **(** :ref:`RID<class_RID>` env, :ref:`EnvironmentBG<enum_VisualServer_EnvironmentBG>` bg **)**
|
|||
|
|
|
|||
|
|
Sets the *BGMode* of the environment. Equivalent to :ref:`Environment.background_mode<class_Environment_property_background_mode>`.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_environment_set_bg_color:
|
|||
|
|
|
|||
|
|
- void **environment_set_bg_color** **(** :ref:`RID<class_RID>` env, :ref:`Color<class_Color>` color **)**
|
|||
|
|
|
|||
|
|
Color displayed for clear areas of the scene (if using Custom color or Color+Sky background modes).
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_environment_set_bg_energy:
|
|||
|
|
|
|||
|
|
- void **environment_set_bg_energy** **(** :ref:`RID<class_RID>` env, :ref:`float<class_float>` energy **)**
|
|||
|
|
|
|||
|
|
Sets the intensity of the background color.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_environment_set_canvas_max_layer:
|
|||
|
|
|
|||
|
|
- void **environment_set_canvas_max_layer** **(** :ref:`RID<class_RID>` env, :ref:`int<class_int>` max_layer **)**
|
|||
|
|
|
|||
|
|
Sets the maximum layer to use if using Canvas background mode.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_environment_set_dof_blur_far:
|
|||
|
|
|
|||
|
|
- void **environment_set_dof_blur_far** **(** :ref:`RID<class_RID>` env, :ref:`bool<class_bool>` enable, :ref:`float<class_float>` distance, :ref:`float<class_float>` transition, :ref:`float<class_float>` far_amount, :ref:`EnvironmentDOFBlurQuality<enum_VisualServer_EnvironmentDOFBlurQuality>` quality **)**
|
|||
|
|
|
|||
|
|
Sets the values to be used with the "DoF Far Blur" post-process effect. See :ref:`Environment<class_Environment>` for more details.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_environment_set_dof_blur_near:
|
|||
|
|
|
|||
|
|
- void **environment_set_dof_blur_near** **(** :ref:`RID<class_RID>` env, :ref:`bool<class_bool>` enable, :ref:`float<class_float>` distance, :ref:`float<class_float>` transition, :ref:`float<class_float>` far_amount, :ref:`EnvironmentDOFBlurQuality<enum_VisualServer_EnvironmentDOFBlurQuality>` quality **)**
|
|||
|
|
|
|||
|
|
Sets the values to be used with the "DoF Near Blur" post-process effect. See :ref:`Environment<class_Environment>` for more details.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_environment_set_fog:
|
|||
|
|
|
|||
|
|
- void **environment_set_fog** **(** :ref:`RID<class_RID>` env, :ref:`bool<class_bool>` enable, :ref:`Color<class_Color>` color, :ref:`Color<class_Color>` sun_color, :ref:`float<class_float>` sun_amount **)**
|
|||
|
|
|
|||
|
|
Sets the variables to be used with the scene fog. See :ref:`Environment<class_Environment>` for more details.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_environment_set_fog_depth:
|
|||
|
|
|
|||
|
|
- void **environment_set_fog_depth** **(** :ref:`RID<class_RID>` env, :ref:`bool<class_bool>` enable, :ref:`float<class_float>` depth_begin, :ref:`float<class_float>` depth_end, :ref:`float<class_float>` depth_curve, :ref:`bool<class_bool>` transmit, :ref:`float<class_float>` transmit_curve **)**
|
|||
|
|
|
|||
|
|
Sets the variables to be used with the fog depth effect. See :ref:`Environment<class_Environment>` for more details.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_environment_set_fog_height:
|
|||
|
|
|
|||
|
|
- void **environment_set_fog_height** **(** :ref:`RID<class_RID>` env, :ref:`bool<class_bool>` enable, :ref:`float<class_float>` min_height, :ref:`float<class_float>` max_height, :ref:`float<class_float>` height_curve **)**
|
|||
|
|
|
|||
|
|
Sets the variables to be used with the fog height effect. See :ref:`Environment<class_Environment>` for more details.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_environment_set_glow:
|
|||
|
|
|
|||
|
|
- void **environment_set_glow** **(** :ref:`RID<class_RID>` env, :ref:`bool<class_bool>` enable, :ref:`int<class_int>` level_flags, :ref:`float<class_float>` intensity, :ref:`float<class_float>` strength, :ref:`float<class_float>` bloom_threshold, :ref:`EnvironmentGlowBlendMode<enum_VisualServer_EnvironmentGlowBlendMode>` blend_mode, :ref:`float<class_float>` hdr_bleed_threshold, :ref:`float<class_float>` hdr_bleed_scale, :ref:`float<class_float>` hdr_luminance_cap, :ref:`bool<class_bool>` bicubic_upscale, :ref:`bool<class_bool>` high_quality **)**
|
|||
|
|
|
|||
|
|
Sets the variables to be used with the "glow" post-process effect. See :ref:`Environment<class_Environment>` for more details.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_environment_set_sky:
|
|||
|
|
|
|||
|
|
- void **environment_set_sky** **(** :ref:`RID<class_RID>` env, :ref:`RID<class_RID>` sky **)**
|
|||
|
|
|
|||
|
|
Sets the :ref:`Sky<class_Sky>` to be used as the environment's background when using *BGMode* sky. Equivalent to :ref:`Environment.background_sky<class_Environment_property_background_sky>`.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_environment_set_sky_custom_fov:
|
|||
|
|
|
|||
|
|
- void **environment_set_sky_custom_fov** **(** :ref:`RID<class_RID>` env, :ref:`float<class_float>` scale **)**
|
|||
|
|
|
|||
|
|
Sets a custom field of view for the background :ref:`Sky<class_Sky>`. Equivalent to :ref:`Environment.background_sky_custom_fov<class_Environment_property_background_sky_custom_fov>`.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_environment_set_sky_orientation:
|
|||
|
|
|
|||
|
|
- void **environment_set_sky_orientation** **(** :ref:`RID<class_RID>` env, :ref:`Basis<class_Basis>` orientation **)**
|
|||
|
|
|
|||
|
|
Sets the rotation of the background :ref:`Sky<class_Sky>` expressed as a :ref:`Basis<class_Basis>`. Equivalent to :ref:`Environment.background_sky_orientation<class_Environment_property_background_sky_orientation>`.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_environment_set_ssao:
|
|||
|
|
|
|||
|
|
- void **environment_set_ssao** **(** :ref:`RID<class_RID>` env, :ref:`bool<class_bool>` enable, :ref:`float<class_float>` radius, :ref:`float<class_float>` intensity, :ref:`float<class_float>` radius2, :ref:`float<class_float>` intensity2, :ref:`float<class_float>` bias, :ref:`float<class_float>` light_affect, :ref:`float<class_float>` ao_channel_affect, :ref:`Color<class_Color>` color, :ref:`EnvironmentSSAOQuality<enum_VisualServer_EnvironmentSSAOQuality>` quality, :ref:`EnvironmentSSAOBlur<enum_VisualServer_EnvironmentSSAOBlur>` blur, :ref:`float<class_float>` bilateral_sharpness **)**
|
|||
|
|
|
|||
|
|
Sets the variables to be used with the "Screen Space Ambient Occlusion (SSAO)" post-process effect. See :ref:`Environment<class_Environment>` for more details.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_environment_set_ssr:
|
|||
|
|
|
|||
|
|
- void **environment_set_ssr** **(** :ref:`RID<class_RID>` env, :ref:`bool<class_bool>` enable, :ref:`int<class_int>` max_steps, :ref:`float<class_float>` fade_in, :ref:`float<class_float>` fade_out, :ref:`float<class_float>` depth_tolerance, :ref:`bool<class_bool>` roughness **)**
|
|||
|
|
|
|||
|
|
Sets the variables to be used with the "screen space reflections" post-process effect. See :ref:`Environment<class_Environment>` for more details.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_environment_set_tonemap:
|
|||
|
|
|
|||
|
|
- void **environment_set_tonemap** **(** :ref:`RID<class_RID>` env, :ref:`EnvironmentToneMapper<enum_VisualServer_EnvironmentToneMapper>` tone_mapper, :ref:`float<class_float>` exposure, :ref:`float<class_float>` white, :ref:`bool<class_bool>` auto_exposure, :ref:`float<class_float>` min_luminance, :ref:`float<class_float>` max_luminance, :ref:`float<class_float>` auto_exp_speed, :ref:`float<class_float>` auto_exp_grey **)**
|
|||
|
|
|
|||
|
|
Sets the variables to be used with the "tonemap" post-process effect. See :ref:`Environment<class_Environment>` for more details.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_finish:
|
|||
|
|
|
|||
|
|
- void **finish** **(** **)**
|
|||
|
|
|
|||
|
|
Removes buffers and clears testcubes.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_force_draw:
|
|||
|
|
|
|||
|
|
- void **force_draw** **(** :ref:`bool<class_bool>` swap_buffers=true, :ref:`float<class_float>` frame_step=0.0 **)**
|
|||
|
|
|
|||
|
|
Forces a frame to be drawn when the function is called. Drawing a frame updates all :ref:`Viewport<class_Viewport>`\ s that are set to update. Use with extreme caution.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_force_sync:
|
|||
|
|
|
|||
|
|
- void **force_sync** **(** **)**
|
|||
|
|
|
|||
|
|
Synchronizes threads.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_free_rid:
|
|||
|
|
|
|||
|
|
- void **free_rid** **(** :ref:`RID<class_RID>` rid **)**
|
|||
|
|
|
|||
|
|
Destroys an object created by the VisualServer. If the :ref:`RID<class_RID>` passed is not one created by the server that created it (e.g. VisualServer, PhysicsServer, etc.), an error will be sent to the console.
|
|||
|
|
|
|||
|
|
\ **Note:** After freeing the object, the RID now has a reference to invalid memory. It is not safe to use or free an invalid RID. Before using the RID again, make sure to assign it to ``RID()`` or any other valid RID.
|
|||
|
|
|
|||
|
|
::
|
|||
|
|
|
|||
|
|
var r: RID = VisualServer.get_test_cube()
|
|||
|
|
VisualServer.free_rid(r)
|
|||
|
|
print("ID: ", r.get_id()) # It is not safe to access or free an invalid RID
|
|||
|
|
r = RID() # Reset the RID so it is safe to use again.
|
|||
|
|
print("ID: ", r.get_id())
|
|||
|
|
|
|||
|
|
# Output:
|
|||
|
|
# ID: 157 # Freed RID has invalid data
|
|||
|
|
# ID: 0 # RID has been properly reset
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_get_render_info:
|
|||
|
|
|
|||
|
|
- :ref:`int<class_int>` **get_render_info** **(** :ref:`RenderInfo<enum_VisualServer_RenderInfo>` info **)**
|
|||
|
|
|
|||
|
|
Returns a certain information, see :ref:`RenderInfo<enum_VisualServer_RenderInfo>` for options.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_get_test_cube:
|
|||
|
|
|
|||
|
|
- :ref:`RID<class_RID>` **get_test_cube** **(** **)**
|
|||
|
|
|
|||
|
|
Returns the id of the test cube. Creates one if none exists.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_get_test_texture:
|
|||
|
|
|
|||
|
|
- :ref:`RID<class_RID>` **get_test_texture** **(** **)**
|
|||
|
|
|
|||
|
|
Returns the id of the test texture. Creates one if none exists.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_get_video_adapter_name:
|
|||
|
|
|
|||
|
|
- :ref:`String<class_String>` **get_video_adapter_name** **(** **)** |const|
|
|||
|
|
|
|||
|
|
Returns the name of the video adapter (e.g. "GeForce GTX 1080/PCIe/SSE2").
|
|||
|
|
|
|||
|
|
\ **Note:** When running a headless or server binary, this function returns an empty string.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_get_video_adapter_vendor:
|
|||
|
|
|
|||
|
|
- :ref:`String<class_String>` **get_video_adapter_vendor** **(** **)** |const|
|
|||
|
|
|
|||
|
|
Returns the vendor of the video adapter (e.g. "NVIDIA Corporation").
|
|||
|
|
|
|||
|
|
\ **Note:** When running a headless or server binary, this function returns an empty string.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_get_white_texture:
|
|||
|
|
|
|||
|
|
- :ref:`RID<class_RID>` **get_white_texture** **(** **)**
|
|||
|
|
|
|||
|
|
Returns the id of a white texture. Creates one if none exists.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_gi_probe_create:
|
|||
|
|
|
|||
|
|
- :ref:`RID<class_RID>` **gi_probe_create** **(** **)**
|
|||
|
|
|
|||
|
|
Creates a GI probe and adds it to the VisualServer. It can be accessed with the RID that is returned. This RID will be used in all ``gi_probe_*`` VisualServer functions.
|
|||
|
|
|
|||
|
|
Once finished with your RID, you will want to free the RID using the VisualServer's :ref:`free_rid<class_VisualServer_method_free_rid>` static method.
|
|||
|
|
|
|||
|
|
To place in a scene, attach this GI probe to an instance using :ref:`instance_set_base<class_VisualServer_method_instance_set_base>` using the returned RID.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_gi_probe_get_bias:
|
|||
|
|
|
|||
|
|
- :ref:`float<class_float>` **gi_probe_get_bias** **(** :ref:`RID<class_RID>` probe **)** |const|
|
|||
|
|
|
|||
|
|
Returns the bias value for the GI probe. Bias is used to avoid self occlusion. Equivalent to :ref:`GIProbeData.bias<class_GIProbeData_property_bias>`.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_gi_probe_get_bounds:
|
|||
|
|
|
|||
|
|
- :ref:`AABB<class_AABB>` **gi_probe_get_bounds** **(** :ref:`RID<class_RID>` probe **)** |const|
|
|||
|
|
|
|||
|
|
Returns the axis-aligned bounding box that covers the full extent of the GI probe.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_gi_probe_get_cell_size:
|
|||
|
|
|
|||
|
|
- :ref:`float<class_float>` **gi_probe_get_cell_size** **(** :ref:`RID<class_RID>` probe **)** |const|
|
|||
|
|
|
|||
|
|
Returns the cell size set by :ref:`gi_probe_set_cell_size<class_VisualServer_method_gi_probe_set_cell_size>`.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_gi_probe_get_dynamic_data:
|
|||
|
|
|
|||
|
|
- :ref:`PoolIntArray<class_PoolIntArray>` **gi_probe_get_dynamic_data** **(** :ref:`RID<class_RID>` probe **)** |const|
|
|||
|
|
|
|||
|
|
Returns the data used by the GI probe.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_gi_probe_get_dynamic_range:
|
|||
|
|
|
|||
|
|
- :ref:`int<class_int>` **gi_probe_get_dynamic_range** **(** :ref:`RID<class_RID>` probe **)** |const|
|
|||
|
|
|
|||
|
|
Returns the dynamic range set for this GI probe. Equivalent to :ref:`GIProbe.dynamic_range<class_GIProbe_property_dynamic_range>`.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_gi_probe_get_energy:
|
|||
|
|
|
|||
|
|
- :ref:`float<class_float>` **gi_probe_get_energy** **(** :ref:`RID<class_RID>` probe **)** |const|
|
|||
|
|
|
|||
|
|
Returns the energy multiplier for this GI probe. Equivalent to :ref:`GIProbe.energy<class_GIProbe_property_energy>`.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_gi_probe_get_normal_bias:
|
|||
|
|
|
|||
|
|
- :ref:`float<class_float>` **gi_probe_get_normal_bias** **(** :ref:`RID<class_RID>` probe **)** |const|
|
|||
|
|
|
|||
|
|
Returns the normal bias for this GI probe. Equivalent to :ref:`GIProbe.normal_bias<class_GIProbe_property_normal_bias>`.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_gi_probe_get_propagation:
|
|||
|
|
|
|||
|
|
- :ref:`float<class_float>` **gi_probe_get_propagation** **(** :ref:`RID<class_RID>` probe **)** |const|
|
|||
|
|
|
|||
|
|
Returns the propagation value for this GI probe. Equivalent to :ref:`GIProbe.propagation<class_GIProbe_property_propagation>`.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_gi_probe_get_to_cell_xform:
|
|||
|
|
|
|||
|
|
- :ref:`Transform<class_Transform>` **gi_probe_get_to_cell_xform** **(** :ref:`RID<class_RID>` probe **)** |const|
|
|||
|
|
|
|||
|
|
Returns the Transform set by :ref:`gi_probe_set_to_cell_xform<class_VisualServer_method_gi_probe_set_to_cell_xform>`.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_gi_probe_is_compressed:
|
|||
|
|
|
|||
|
|
- :ref:`bool<class_bool>` **gi_probe_is_compressed** **(** :ref:`RID<class_RID>` probe **)** |const|
|
|||
|
|
|
|||
|
|
Returns ``true`` if the GI probe data associated with this GI probe is compressed. Equivalent to :ref:`GIProbe.compress<class_GIProbe_property_compress>`.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_gi_probe_is_interior:
|
|||
|
|
|
|||
|
|
- :ref:`bool<class_bool>` **gi_probe_is_interior** **(** :ref:`RID<class_RID>` probe **)** |const|
|
|||
|
|
|
|||
|
|
Returns ``true`` if the GI probe is set to interior, meaning it does not account for sky light. Equivalent to :ref:`GIProbe.interior<class_GIProbe_property_interior>`.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_gi_probe_set_bias:
|
|||
|
|
|
|||
|
|
- void **gi_probe_set_bias** **(** :ref:`RID<class_RID>` probe, :ref:`float<class_float>` bias **)**
|
|||
|
|
|
|||
|
|
Sets the bias value to avoid self-occlusion. Equivalent to :ref:`GIProbe.bias<class_GIProbe_property_bias>`.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_gi_probe_set_bounds:
|
|||
|
|
|
|||
|
|
- void **gi_probe_set_bounds** **(** :ref:`RID<class_RID>` probe, :ref:`AABB<class_AABB>` bounds **)**
|
|||
|
|
|
|||
|
|
Sets the axis-aligned bounding box that covers the extent of the GI probe.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_gi_probe_set_cell_size:
|
|||
|
|
|
|||
|
|
- void **gi_probe_set_cell_size** **(** :ref:`RID<class_RID>` probe, :ref:`float<class_float>` range **)**
|
|||
|
|
|
|||
|
|
Sets the size of individual cells within the GI probe.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_gi_probe_set_compress:
|
|||
|
|
|
|||
|
|
- void **gi_probe_set_compress** **(** :ref:`RID<class_RID>` probe, :ref:`bool<class_bool>` enable **)**
|
|||
|
|
|
|||
|
|
Sets the compression setting for the GI probe data. Compressed data will take up less space but may look worse. Equivalent to :ref:`GIProbe.compress<class_GIProbe_property_compress>`.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_gi_probe_set_dynamic_data:
|
|||
|
|
|
|||
|
|
- void **gi_probe_set_dynamic_data** **(** :ref:`RID<class_RID>` probe, :ref:`PoolIntArray<class_PoolIntArray>` data **)**
|
|||
|
|
|
|||
|
|
Sets the data to be used in the GI probe for lighting calculations. Normally this is created and called internally within the :ref:`GIProbe<class_GIProbe>` node. You should not try to set this yourself.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_gi_probe_set_dynamic_range:
|
|||
|
|
|
|||
|
|
- void **gi_probe_set_dynamic_range** **(** :ref:`RID<class_RID>` probe, :ref:`int<class_int>` range **)**
|
|||
|
|
|
|||
|
|
Sets the dynamic range of the GI probe. Dynamic range sets the limit for how bright lights can be. A smaller range captures greater detail but limits how bright lights can be. Equivalent to :ref:`GIProbe.dynamic_range<class_GIProbe_property_dynamic_range>`.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_gi_probe_set_energy:
|
|||
|
|
|
|||
|
|
- void **gi_probe_set_energy** **(** :ref:`RID<class_RID>` probe, :ref:`float<class_float>` energy **)**
|
|||
|
|
|
|||
|
|
Sets the energy multiplier for this GI probe. A higher energy makes the indirect light from the GI probe brighter. Equivalent to :ref:`GIProbe.energy<class_GIProbe_property_energy>`.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_gi_probe_set_interior:
|
|||
|
|
|
|||
|
|
- void **gi_probe_set_interior** **(** :ref:`RID<class_RID>` probe, :ref:`bool<class_bool>` enable **)**
|
|||
|
|
|
|||
|
|
Sets the interior value of this GI probe. A GI probe set to interior does not include the sky when calculating lighting. Equivalent to :ref:`GIProbe.interior<class_GIProbe_property_interior>`.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_gi_probe_set_normal_bias:
|
|||
|
|
|
|||
|
|
- void **gi_probe_set_normal_bias** **(** :ref:`RID<class_RID>` probe, :ref:`float<class_float>` bias **)**
|
|||
|
|
|
|||
|
|
Sets the normal bias for this GI probe. Normal bias behaves similar to the other form of bias and may help reduce self-occlusion. Equivalent to :ref:`GIProbe.normal_bias<class_GIProbe_property_normal_bias>`.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_gi_probe_set_propagation:
|
|||
|
|
|
|||
|
|
- void **gi_probe_set_propagation** **(** :ref:`RID<class_RID>` probe, :ref:`float<class_float>` propagation **)**
|
|||
|
|
|
|||
|
|
Sets the propagation of light within this GI probe. Equivalent to :ref:`GIProbe.propagation<class_GIProbe_property_propagation>`.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_gi_probe_set_to_cell_xform:
|
|||
|
|
|
|||
|
|
- void **gi_probe_set_to_cell_xform** **(** :ref:`RID<class_RID>` probe, :ref:`Transform<class_Transform>` xform **)**
|
|||
|
|
|
|||
|
|
Sets the to cell :ref:`Transform<class_Transform>` for this GI probe.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_has_changed:
|
|||
|
|
|
|||
|
|
- :ref:`bool<class_bool>` **has_changed** **(** :ref:`ChangedPriority<enum_VisualServer_ChangedPriority>` queried_priority=0 **)** |const|
|
|||
|
|
|
|||
|
|
Returns ``true`` if changes have been made to the VisualServer's data. :ref:`draw<class_VisualServer_method_draw>` is usually called if this happens.
|
|||
|
|
|
|||
|
|
As changes are registered as either high or low priority (e.g. dynamic shaders), this function takes an optional argument to query either low or high priority changes, or any changes.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_has_feature:
|
|||
|
|
|
|||
|
|
- :ref:`bool<class_bool>` **has_feature** **(** :ref:`Features<enum_VisualServer_Features>` feature **)** |const|
|
|||
|
|
|
|||
|
|
Not yet implemented. Always returns ``false``.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_has_os_feature:
|
|||
|
|
|
|||
|
|
- :ref:`bool<class_bool>` **has_os_feature** **(** :ref:`String<class_String>` feature **)** |const|
|
|||
|
|
|
|||
|
|
Returns ``true`` if the OS supports a certain feature. Features might be ``s3tc``, ``etc``, ``etc2``, ``pvrtc`` and ``skinning_fallback``.
|
|||
|
|
|
|||
|
|
When rendering with GLES2, returns ``true`` with ``skinning_fallback`` in case the hardware doesn't support the default GPU skinning process.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_immediate_begin:
|
|||
|
|
|
|||
|
|
- void **immediate_begin** **(** :ref:`RID<class_RID>` immediate, :ref:`PrimitiveType<enum_VisualServer_PrimitiveType>` primitive, :ref:`RID<class_RID>` texture **)**
|
|||
|
|
|
|||
|
|
Sets up :ref:`ImmediateGeometry<class_ImmediateGeometry>` internals to prepare for drawing. Equivalent to :ref:`ImmediateGeometry.begin<class_ImmediateGeometry_method_begin>`.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_immediate_clear:
|
|||
|
|
|
|||
|
|
- void **immediate_clear** **(** :ref:`RID<class_RID>` immediate **)**
|
|||
|
|
|
|||
|
|
Clears everything that was set up between :ref:`immediate_begin<class_VisualServer_method_immediate_begin>` and :ref:`immediate_end<class_VisualServer_method_immediate_end>`. Equivalent to :ref:`ImmediateGeometry.clear<class_ImmediateGeometry_method_clear>`.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_immediate_color:
|
|||
|
|
|
|||
|
|
- void **immediate_color** **(** :ref:`RID<class_RID>` immediate, :ref:`Color<class_Color>` color **)**
|
|||
|
|
|
|||
|
|
Sets the color to be used with next vertex. Equivalent to :ref:`ImmediateGeometry.set_color<class_ImmediateGeometry_method_set_color>`.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_immediate_create:
|
|||
|
|
|
|||
|
|
- :ref:`RID<class_RID>` **immediate_create** **(** **)**
|
|||
|
|
|
|||
|
|
Creates an immediate geometry and adds it to the VisualServer. It can be accessed with the RID that is returned. This RID will be used in all ``immediate_*`` VisualServer functions.
|
|||
|
|
|
|||
|
|
Once finished with your RID, you will want to free the RID using the VisualServer's :ref:`free_rid<class_VisualServer_method_free_rid>` static method.
|
|||
|
|
|
|||
|
|
To place in a scene, attach this immediate geometry to an instance using :ref:`instance_set_base<class_VisualServer_method_instance_set_base>` using the returned RID.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_immediate_end:
|
|||
|
|
|
|||
|
|
- void **immediate_end** **(** :ref:`RID<class_RID>` immediate **)**
|
|||
|
|
|
|||
|
|
Ends drawing the :ref:`ImmediateGeometry<class_ImmediateGeometry>` and displays it. Equivalent to :ref:`ImmediateGeometry.end<class_ImmediateGeometry_method_end>`.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_immediate_get_material:
|
|||
|
|
|
|||
|
|
- :ref:`RID<class_RID>` **immediate_get_material** **(** :ref:`RID<class_RID>` immediate **)** |const|
|
|||
|
|
|
|||
|
|
Returns the material assigned to the :ref:`ImmediateGeometry<class_ImmediateGeometry>`.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_immediate_normal:
|
|||
|
|
|
|||
|
|
- void **immediate_normal** **(** :ref:`RID<class_RID>` immediate, :ref:`Vector3<class_Vector3>` normal **)**
|
|||
|
|
|
|||
|
|
Sets the normal to be used with next vertex. Equivalent to :ref:`ImmediateGeometry.set_normal<class_ImmediateGeometry_method_set_normal>`.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_immediate_set_material:
|
|||
|
|
|
|||
|
|
- void **immediate_set_material** **(** :ref:`RID<class_RID>` immediate, :ref:`RID<class_RID>` material **)**
|
|||
|
|
|
|||
|
|
Sets the material to be used to draw the :ref:`ImmediateGeometry<class_ImmediateGeometry>`.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_immediate_tangent:
|
|||
|
|
|
|||
|
|
- void **immediate_tangent** **(** :ref:`RID<class_RID>` immediate, :ref:`Plane<class_Plane>` tangent **)**
|
|||
|
|
|
|||
|
|
Sets the tangent to be used with next vertex. Equivalent to :ref:`ImmediateGeometry.set_tangent<class_ImmediateGeometry_method_set_tangent>`.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_immediate_uv:
|
|||
|
|
|
|||
|
|
- void **immediate_uv** **(** :ref:`RID<class_RID>` immediate, :ref:`Vector2<class_Vector2>` tex_uv **)**
|
|||
|
|
|
|||
|
|
Sets the UV to be used with next vertex. Equivalent to :ref:`ImmediateGeometry.set_uv<class_ImmediateGeometry_method_set_uv>`.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_immediate_uv2:
|
|||
|
|
|
|||
|
|
- void **immediate_uv2** **(** :ref:`RID<class_RID>` immediate, :ref:`Vector2<class_Vector2>` tex_uv **)**
|
|||
|
|
|
|||
|
|
Sets the UV2 to be used with next vertex. Equivalent to :ref:`ImmediateGeometry.set_uv2<class_ImmediateGeometry_method_set_uv2>`.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_immediate_vertex:
|
|||
|
|
|
|||
|
|
- void **immediate_vertex** **(** :ref:`RID<class_RID>` immediate, :ref:`Vector3<class_Vector3>` vertex **)**
|
|||
|
|
|
|||
|
|
Adds the next vertex using the information provided in advance. Equivalent to :ref:`ImmediateGeometry.add_vertex<class_ImmediateGeometry_method_add_vertex>`.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_immediate_vertex_2d:
|
|||
|
|
|
|||
|
|
- void **immediate_vertex_2d** **(** :ref:`RID<class_RID>` immediate, :ref:`Vector2<class_Vector2>` vertex **)**
|
|||
|
|
|
|||
|
|
Adds the next vertex using the information provided in advance. This is a helper class that calls :ref:`immediate_vertex<class_VisualServer_method_immediate_vertex>` under the hood. Equivalent to :ref:`ImmediateGeometry.add_vertex<class_ImmediateGeometry_method_add_vertex>`.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_init:
|
|||
|
|
|
|||
|
|
- void **init** **(** **)**
|
|||
|
|
|
|||
|
|
Initializes the visual server. This function is called internally by platform-dependent code during engine initialization. If called from a running game, it will not do anything.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_instance_attach_object_instance_id:
|
|||
|
|
|
|||
|
|
- void **instance_attach_object_instance_id** **(** :ref:`RID<class_RID>` instance, :ref:`int<class_int>` id **)**
|
|||
|
|
|
|||
|
|
Attaches a unique Object ID to instance. Object ID must be attached to instance for proper culling with :ref:`instances_cull_aabb<class_VisualServer_method_instances_cull_aabb>`, :ref:`instances_cull_convex<class_VisualServer_method_instances_cull_convex>`, and :ref:`instances_cull_ray<class_VisualServer_method_instances_cull_ray>`.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_instance_attach_skeleton:
|
|||
|
|
|
|||
|
|
- void **instance_attach_skeleton** **(** :ref:`RID<class_RID>` instance, :ref:`RID<class_RID>` skeleton **)**
|
|||
|
|
|
|||
|
|
Attaches a skeleton to an instance. Removes the previous skeleton from the instance.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_instance_create:
|
|||
|
|
|
|||
|
|
- :ref:`RID<class_RID>` **instance_create** **(** **)**
|
|||
|
|
|
|||
|
|
Creates a visual instance and adds it to the VisualServer. It can be accessed with the RID that is returned. This RID will be used in all ``instance_*`` VisualServer functions.
|
|||
|
|
|
|||
|
|
Once finished with your RID, you will want to free the RID using the VisualServer's :ref:`free_rid<class_VisualServer_method_free_rid>` static method.
|
|||
|
|
|
|||
|
|
An instance is a way of placing a 3D object in the scenario. Objects like particles, meshes, and reflection probes need to be associated with an instance to be visible in the scenario using :ref:`instance_set_base<class_VisualServer_method_instance_set_base>`.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_instance_create2:
|
|||
|
|
|
|||
|
|
- :ref:`RID<class_RID>` **instance_create2** **(** :ref:`RID<class_RID>` base, :ref:`RID<class_RID>` scenario **)**
|
|||
|
|
|
|||
|
|
Creates a visual instance, adds it to the VisualServer, and sets both base and scenario. It can be accessed with the RID that is returned. This RID will be used in all ``instance_*`` VisualServer functions.
|
|||
|
|
|
|||
|
|
Once finished with your RID, you will want to free the RID using the VisualServer's :ref:`free_rid<class_VisualServer_method_free_rid>` static method.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_instance_geometry_set_as_instance_lod:
|
|||
|
|
|
|||
|
|
- void **instance_geometry_set_as_instance_lod** **(** :ref:`RID<class_RID>` instance, :ref:`RID<class_RID>` as_lod_of_instance **)**
|
|||
|
|
|
|||
|
|
Not implemented in Godot 3.x.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_instance_geometry_set_cast_shadows_setting:
|
|||
|
|
|
|||
|
|
- void **instance_geometry_set_cast_shadows_setting** **(** :ref:`RID<class_RID>` instance, :ref:`ShadowCastingSetting<enum_VisualServer_ShadowCastingSetting>` shadow_casting_setting **)**
|
|||
|
|
|
|||
|
|
Sets the shadow casting setting to one of :ref:`ShadowCastingSetting<enum_VisualServer_ShadowCastingSetting>`. Equivalent to :ref:`GeometryInstance.cast_shadow<class_GeometryInstance_property_cast_shadow>`.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_instance_geometry_set_draw_range:
|
|||
|
|
|
|||
|
|
- void **instance_geometry_set_draw_range** **(** :ref:`RID<class_RID>` instance, :ref:`float<class_float>` min, :ref:`float<class_float>` max, :ref:`float<class_float>` min_margin, :ref:`float<class_float>` max_margin **)**
|
|||
|
|
|
|||
|
|
Not implemented in Godot 3.x.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_instance_geometry_set_flag:
|
|||
|
|
|
|||
|
|
- void **instance_geometry_set_flag** **(** :ref:`RID<class_RID>` instance, :ref:`InstanceFlags<enum_VisualServer_InstanceFlags>` flag, :ref:`bool<class_bool>` enabled **)**
|
|||
|
|
|
|||
|
|
Sets the flag for a given :ref:`InstanceFlags<enum_VisualServer_InstanceFlags>`. See :ref:`InstanceFlags<enum_VisualServer_InstanceFlags>` for more details.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_instance_geometry_set_material_overlay:
|
|||
|
|
|
|||
|
|
- void **instance_geometry_set_material_overlay** **(** :ref:`RID<class_RID>` instance, :ref:`RID<class_RID>` material **)**
|
|||
|
|
|
|||
|
|
Sets a material that will be rendered for all surfaces on top of active materials for the mesh associated with this instance. Equivalent to :ref:`GeometryInstance.material_overlay<class_GeometryInstance_property_material_overlay>`.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_instance_geometry_set_material_override:
|
|||
|
|
|
|||
|
|
- void **instance_geometry_set_material_override** **(** :ref:`RID<class_RID>` instance, :ref:`RID<class_RID>` material **)**
|
|||
|
|
|
|||
|
|
Sets a material that will override the material for all surfaces on the mesh associated with this instance. Equivalent to :ref:`GeometryInstance.material_override<class_GeometryInstance_property_material_override>`.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_instance_reset_physics_interpolation:
|
|||
|
|
|
|||
|
|
- void **instance_reset_physics_interpolation** **(** :ref:`RID<class_RID>` instance **)**
|
|||
|
|
|
|||
|
|
Prevents physics interpolation for the current physics tick.
|
|||
|
|
|
|||
|
|
This is useful when moving an instance to a new location, to give an instantaneous change rather than interpolation from the previous location.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_instance_set_base:
|
|||
|
|
|
|||
|
|
- void **instance_set_base** **(** :ref:`RID<class_RID>` instance, :ref:`RID<class_RID>` base **)**
|
|||
|
|
|
|||
|
|
Sets the base of the instance. A base can be any of the 3D objects that are created in the VisualServer that can be displayed. For example, any of the light types, mesh, multimesh, immediate geometry, particle system, reflection probe, lightmap capture, and the GI probe are all types that can be set as the base of an instance in order to be displayed in the scenario.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_instance_set_blend_shape_weight:
|
|||
|
|
|
|||
|
|
- void **instance_set_blend_shape_weight** **(** :ref:`RID<class_RID>` instance, :ref:`int<class_int>` shape, :ref:`float<class_float>` weight **)**
|
|||
|
|
|
|||
|
|
Sets the weight for a given blend shape associated with this instance.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_instance_set_custom_aabb:
|
|||
|
|
|
|||
|
|
- void **instance_set_custom_aabb** **(** :ref:`RID<class_RID>` instance, :ref:`AABB<class_AABB>` aabb **)**
|
|||
|
|
|
|||
|
|
Sets a custom AABB to use when culling objects from the view frustum. Equivalent to :ref:`GeometryInstance.set_custom_aabb<class_GeometryInstance_method_set_custom_aabb>`.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_instance_set_exterior:
|
|||
|
|
|
|||
|
|
- void **instance_set_exterior** **(** :ref:`RID<class_RID>` instance, :ref:`bool<class_bool>` enabled **)**
|
|||
|
|
|
|||
|
|
Function not implemented in Godot 3.x.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_instance_set_extra_visibility_margin:
|
|||
|
|
|
|||
|
|
- void **instance_set_extra_visibility_margin** **(** :ref:`RID<class_RID>` instance, :ref:`float<class_float>` margin **)**
|
|||
|
|
|
|||
|
|
Sets a margin to increase the size of the AABB when culling objects from the view frustum. This allows you to avoid culling objects that fall outside the view frustum. Equivalent to :ref:`GeometryInstance.extra_cull_margin<class_GeometryInstance_property_extra_cull_margin>`.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_instance_set_interpolated:
|
|||
|
|
|
|||
|
|
- void **instance_set_interpolated** **(** :ref:`RID<class_RID>` instance, :ref:`bool<class_bool>` interpolated **)**
|
|||
|
|
|
|||
|
|
Turns on and off physics interpolation for the instance.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_instance_set_layer_mask:
|
|||
|
|
|
|||
|
|
- void **instance_set_layer_mask** **(** :ref:`RID<class_RID>` instance, :ref:`int<class_int>` mask **)**
|
|||
|
|
|
|||
|
|
Sets the render layers that this instance will be drawn to. Equivalent to :ref:`VisualInstance.layers<class_VisualInstance_property_layers>`.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_instance_set_scenario:
|
|||
|
|
|
|||
|
|
- void **instance_set_scenario** **(** :ref:`RID<class_RID>` instance, :ref:`RID<class_RID>` scenario **)**
|
|||
|
|
|
|||
|
|
Sets the scenario that the instance is in. The scenario is the 3D world that the objects will be displayed in.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_instance_set_surface_material:
|
|||
|
|
|
|||
|
|
- void **instance_set_surface_material** **(** :ref:`RID<class_RID>` instance, :ref:`int<class_int>` surface, :ref:`RID<class_RID>` material **)**
|
|||
|
|
|
|||
|
|
Sets the material of a specific surface. Equivalent to :ref:`MeshInstance.set_surface_material<class_MeshInstance_method_set_surface_material>`.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_instance_set_transform:
|
|||
|
|
|
|||
|
|
- void **instance_set_transform** **(** :ref:`RID<class_RID>` instance, :ref:`Transform<class_Transform>` transform **)**
|
|||
|
|
|
|||
|
|
Sets the world space transform of the instance. Equivalent to :ref:`Spatial.transform<class_Spatial_property_transform>`.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_instance_set_use_lightmap:
|
|||
|
|
|
|||
|
|
- void **instance_set_use_lightmap** **(** :ref:`RID<class_RID>` instance, :ref:`RID<class_RID>` lightmap_instance, :ref:`RID<class_RID>` lightmap, :ref:`int<class_int>` lightmap_slice=-1, :ref:`Rect2<class_Rect2>` lightmap_uv_rect=Rect2( 0, 0, 1, 1 ) **)**
|
|||
|
|
|
|||
|
|
Sets the lightmap to use with this instance.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_instance_set_visible:
|
|||
|
|
|
|||
|
|
- void **instance_set_visible** **(** :ref:`RID<class_RID>` instance, :ref:`bool<class_bool>` visible **)**
|
|||
|
|
|
|||
|
|
Sets whether an instance is drawn or not. Equivalent to :ref:`Spatial.visible<class_Spatial_property_visible>`.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_instances_cull_aabb:
|
|||
|
|
|
|||
|
|
- :ref:`Array<class_Array>` **instances_cull_aabb** **(** :ref:`AABB<class_AABB>` aabb, :ref:`RID<class_RID>` scenario **)** |const|
|
|||
|
|
|
|||
|
|
Returns an array of object IDs intersecting with the provided AABB. Only visual 3D nodes are considered, such as :ref:`MeshInstance<class_MeshInstance>` or :ref:`DirectionalLight<class_DirectionalLight>`. Use :ref:`@GDScript.instance_from_id<class_@GDScript_method_instance_from_id>` to obtain the actual nodes. A scenario RID must be provided, which is available in the :ref:`World<class_World>` you want to query. This forces an update for all resources queued to update.
|
|||
|
|
|
|||
|
|
\ **Warning:** This function is primarily intended for editor usage. For in-game use cases, prefer physics collision.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_instances_cull_convex:
|
|||
|
|
|
|||
|
|
- :ref:`Array<class_Array>` **instances_cull_convex** **(** :ref:`Array<class_Array>` convex, :ref:`RID<class_RID>` scenario **)** |const|
|
|||
|
|
|
|||
|
|
Returns an array of object IDs intersecting with the provided convex shape. Only visual 3D nodes are considered, such as :ref:`MeshInstance<class_MeshInstance>` or :ref:`DirectionalLight<class_DirectionalLight>`. Use :ref:`@GDScript.instance_from_id<class_@GDScript_method_instance_from_id>` to obtain the actual nodes. A scenario RID must be provided, which is available in the :ref:`World<class_World>` you want to query. This forces an update for all resources queued to update.
|
|||
|
|
|
|||
|
|
\ **Warning:** This function is primarily intended for editor usage. For in-game use cases, prefer physics collision.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_instances_cull_ray:
|
|||
|
|
|
|||
|
|
- :ref:`Array<class_Array>` **instances_cull_ray** **(** :ref:`Vector3<class_Vector3>` from, :ref:`Vector3<class_Vector3>` to, :ref:`RID<class_RID>` scenario **)** |const|
|
|||
|
|
|
|||
|
|
Returns an array of object IDs intersecting with the provided 3D ray. Only visual 3D nodes are considered, such as :ref:`MeshInstance<class_MeshInstance>` or :ref:`DirectionalLight<class_DirectionalLight>`. Use :ref:`@GDScript.instance_from_id<class_@GDScript_method_instance_from_id>` to obtain the actual nodes. A scenario RID must be provided, which is available in the :ref:`World<class_World>` you want to query. This forces an update for all resources queued to update.
|
|||
|
|
|
|||
|
|
\ **Warning:** This function is primarily intended for editor usage. For in-game use cases, prefer physics collision.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_light_directional_set_blend_splits:
|
|||
|
|
|
|||
|
|
- void **light_directional_set_blend_splits** **(** :ref:`RID<class_RID>` light, :ref:`bool<class_bool>` enable **)**
|
|||
|
|
|
|||
|
|
If ``true``, this directional light will blend between shadow map splits resulting in a smoother transition between them. Equivalent to :ref:`DirectionalLight.directional_shadow_blend_splits<class_DirectionalLight_property_directional_shadow_blend_splits>`.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_light_directional_set_shadow_depth_range_mode:
|
|||
|
|
|
|||
|
|
- void **light_directional_set_shadow_depth_range_mode** **(** :ref:`RID<class_RID>` light, :ref:`LightDirectionalShadowDepthRangeMode<enum_VisualServer_LightDirectionalShadowDepthRangeMode>` range_mode **)**
|
|||
|
|
|
|||
|
|
Sets the shadow depth range mode for this directional light. Equivalent to :ref:`DirectionalLight.directional_shadow_depth_range<class_DirectionalLight_property_directional_shadow_depth_range>`. See :ref:`LightDirectionalShadowDepthRangeMode<enum_VisualServer_LightDirectionalShadowDepthRangeMode>` for options.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_light_directional_set_shadow_mode:
|
|||
|
|
|
|||
|
|
- void **light_directional_set_shadow_mode** **(** :ref:`RID<class_RID>` light, :ref:`LightDirectionalShadowMode<enum_VisualServer_LightDirectionalShadowMode>` mode **)**
|
|||
|
|
|
|||
|
|
Sets the shadow mode for this directional light. Equivalent to :ref:`DirectionalLight.directional_shadow_mode<class_DirectionalLight_property_directional_shadow_mode>`. See :ref:`LightDirectionalShadowMode<enum_VisualServer_LightDirectionalShadowMode>` for options.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_light_omni_set_shadow_detail:
|
|||
|
|
|
|||
|
|
- void **light_omni_set_shadow_detail** **(** :ref:`RID<class_RID>` light, :ref:`LightOmniShadowDetail<enum_VisualServer_LightOmniShadowDetail>` detail **)**
|
|||
|
|
|
|||
|
|
Sets whether to use vertical or horizontal detail for this omni light. This can be used to alleviate artifacts in the shadow map. Equivalent to :ref:`OmniLight.omni_shadow_detail<class_OmniLight_property_omni_shadow_detail>`.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_light_omni_set_shadow_mode:
|
|||
|
|
|
|||
|
|
- void **light_omni_set_shadow_mode** **(** :ref:`RID<class_RID>` light, :ref:`LightOmniShadowMode<enum_VisualServer_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:`OmniLight.omni_shadow_mode<class_OmniLight_property_omni_shadow_mode>`.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_light_set_bake_mode:
|
|||
|
|
|
|||
|
|
- void **light_set_bake_mode** **(** :ref:`RID<class_RID>` light, :ref:`LightBakeMode<enum_VisualServer_LightBakeMode>` bake_mode **)**
|
|||
|
|
|
|||
|
|
Sets the bake mode for this light, see :ref:`LightBakeMode<enum_VisualServer_LightBakeMode>` for options. The bake mode affects how the light will be baked in :ref:`BakedLightmap<class_BakedLightmap>`\ s and :ref:`GIProbe<class_GIProbe>`\ s.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_light_set_color:
|
|||
|
|
|
|||
|
|
- void **light_set_color** **(** :ref:`RID<class_RID>` light, :ref:`Color<class_Color>` color **)**
|
|||
|
|
|
|||
|
|
Sets the color of the light. Equivalent to :ref:`Light.light_color<class_Light_property_light_color>`.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_light_set_cull_mask:
|
|||
|
|
|
|||
|
|
- void **light_set_cull_mask** **(** :ref:`RID<class_RID>` light, :ref:`int<class_int>` mask **)**
|
|||
|
|
|
|||
|
|
Sets the cull mask for this Light. Lights only affect objects in the selected layers. Equivalent to :ref:`Light.light_cull_mask<class_Light_property_light_cull_mask>`.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_light_set_negative:
|
|||
|
|
|
|||
|
|
- void **light_set_negative** **(** :ref:`RID<class_RID>` light, :ref:`bool<class_bool>` enable **)**
|
|||
|
|
|
|||
|
|
If ``true``, light will subtract light instead of adding light. Equivalent to :ref:`Light.light_negative<class_Light_property_light_negative>`.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_light_set_param:
|
|||
|
|
|
|||
|
|
- void **light_set_param** **(** :ref:`RID<class_RID>` light, :ref:`LightParam<enum_VisualServer_LightParam>` param, :ref:`float<class_float>` value **)**
|
|||
|
|
|
|||
|
|
Sets the specified light parameter. See :ref:`LightParam<enum_VisualServer_LightParam>` for options. Equivalent to :ref:`Light.set_param<class_Light_method_set_param>`.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_light_set_projector:
|
|||
|
|
|
|||
|
|
- void **light_set_projector** **(** :ref:`RID<class_RID>` light, :ref:`RID<class_RID>` texture **)**
|
|||
|
|
|
|||
|
|
Not implemented in Godot 3.x.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_light_set_reverse_cull_face_mode:
|
|||
|
|
|
|||
|
|
- void **light_set_reverse_cull_face_mode** **(** :ref:`RID<class_RID>` light, :ref:`bool<class_bool>` enabled **)**
|
|||
|
|
|
|||
|
|
If ``true``, reverses the backface culling of the mesh. This can be useful when you have a flat mesh that has a light behind it. If you need to cast a shadow on both sides of the mesh, set the mesh to use double sided shadows with :ref:`instance_geometry_set_cast_shadows_setting<class_VisualServer_method_instance_geometry_set_cast_shadows_setting>`. Equivalent to :ref:`Light.shadow_reverse_cull_face<class_Light_property_shadow_reverse_cull_face>`.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_light_set_shadow:
|
|||
|
|
|
|||
|
|
- void **light_set_shadow** **(** :ref:`RID<class_RID>` light, :ref:`bool<class_bool>` enabled **)**
|
|||
|
|
|
|||
|
|
If ``true``, light will cast shadows. Equivalent to :ref:`Light.shadow_enabled<class_Light_property_shadow_enabled>`.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_light_set_shadow_color:
|
|||
|
|
|
|||
|
|
- void **light_set_shadow_color** **(** :ref:`RID<class_RID>` light, :ref:`Color<class_Color>` color **)**
|
|||
|
|
|
|||
|
|
Sets the color of the shadow cast by the light. Equivalent to :ref:`Light.shadow_color<class_Light_property_shadow_color>`.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_light_set_use_gi:
|
|||
|
|
|
|||
|
|
- void **light_set_use_gi** **(** :ref:`RID<class_RID>` light, :ref:`bool<class_bool>` enabled **)**
|
|||
|
|
|
|||
|
|
Sets whether GI probes capture light information from this light. *Deprecated method.* Use :ref:`light_set_bake_mode<class_VisualServer_method_light_set_bake_mode>` instead. This method is only kept for compatibility reasons and calls :ref:`light_set_bake_mode<class_VisualServer_method_light_set_bake_mode>` internally, setting the bake mode to :ref:`LIGHT_BAKE_DISABLED<class_VisualServer_constant_LIGHT_BAKE_DISABLED>` or :ref:`LIGHT_BAKE_INDIRECT<class_VisualServer_constant_LIGHT_BAKE_INDIRECT>` depending on the given parameter.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_lightmap_capture_create:
|
|||
|
|
|
|||
|
|
- :ref:`RID<class_RID>` **lightmap_capture_create** **(** **)**
|
|||
|
|
|
|||
|
|
Creates a lightmap capture and adds it to the VisualServer. It can be accessed with the RID that is returned. This RID will be used in all ``lightmap_capture_*`` VisualServer functions.
|
|||
|
|
|
|||
|
|
Once finished with your RID, you will want to free the RID using the VisualServer's :ref:`free_rid<class_VisualServer_method_free_rid>` static method.
|
|||
|
|
|
|||
|
|
To place in a scene, attach this lightmap capture to an instance using :ref:`instance_set_base<class_VisualServer_method_instance_set_base>` using the returned RID.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_lightmap_capture_get_bounds:
|
|||
|
|
|
|||
|
|
- :ref:`AABB<class_AABB>` **lightmap_capture_get_bounds** **(** :ref:`RID<class_RID>` capture **)** |const|
|
|||
|
|
|
|||
|
|
Returns the size of the lightmap capture area.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_lightmap_capture_get_energy:
|
|||
|
|
|
|||
|
|
- :ref:`float<class_float>` **lightmap_capture_get_energy** **(** :ref:`RID<class_RID>` capture **)** |const|
|
|||
|
|
|
|||
|
|
Returns the energy multiplier used by the lightmap capture.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_lightmap_capture_get_octree:
|
|||
|
|
|
|||
|
|
- :ref:`PoolByteArray<class_PoolByteArray>` **lightmap_capture_get_octree** **(** :ref:`RID<class_RID>` capture **)** |const|
|
|||
|
|
|
|||
|
|
Returns the octree used by the lightmap capture.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_lightmap_capture_get_octree_cell_subdiv:
|
|||
|
|
|
|||
|
|
- :ref:`int<class_int>` **lightmap_capture_get_octree_cell_subdiv** **(** :ref:`RID<class_RID>` capture **)** |const|
|
|||
|
|
|
|||
|
|
Returns the cell subdivision amount used by this lightmap capture's octree.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_lightmap_capture_get_octree_cell_transform:
|
|||
|
|
|
|||
|
|
- :ref:`Transform<class_Transform>` **lightmap_capture_get_octree_cell_transform** **(** :ref:`RID<class_RID>` capture **)** |const|
|
|||
|
|
|
|||
|
|
Returns the cell transform for this lightmap capture's octree.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_lightmap_capture_is_interior:
|
|||
|
|
|
|||
|
|
- :ref:`bool<class_bool>` **lightmap_capture_is_interior** **(** :ref:`RID<class_RID>` capture **)** |const|
|
|||
|
|
|
|||
|
|
Returns ``true`` if capture is in "interior" mode.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_lightmap_capture_set_bounds:
|
|||
|
|
|
|||
|
|
- void **lightmap_capture_set_bounds** **(** :ref:`RID<class_RID>` capture, :ref:`AABB<class_AABB>` bounds **)**
|
|||
|
|
|
|||
|
|
Sets the size of the area covered by the lightmap capture. Equivalent to :ref:`BakedLightmapData.bounds<class_BakedLightmapData_property_bounds>`.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_lightmap_capture_set_energy:
|
|||
|
|
|
|||
|
|
- void **lightmap_capture_set_energy** **(** :ref:`RID<class_RID>` capture, :ref:`float<class_float>` energy **)**
|
|||
|
|
|
|||
|
|
Sets the energy multiplier for this lightmap capture. Equivalent to :ref:`BakedLightmapData.energy<class_BakedLightmapData_property_energy>`.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_lightmap_capture_set_interior:
|
|||
|
|
|
|||
|
|
- void **lightmap_capture_set_interior** **(** :ref:`RID<class_RID>` capture, :ref:`bool<class_bool>` interior **)**
|
|||
|
|
|
|||
|
|
Sets the "interior" mode for this lightmap capture. Equivalent to :ref:`BakedLightmapData.interior<class_BakedLightmapData_property_interior>`.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_lightmap_capture_set_octree:
|
|||
|
|
|
|||
|
|
- void **lightmap_capture_set_octree** **(** :ref:`RID<class_RID>` capture, :ref:`PoolByteArray<class_PoolByteArray>` octree **)**
|
|||
|
|
|
|||
|
|
Sets the octree to be used by this lightmap capture. This function is normally used by the :ref:`BakedLightmap<class_BakedLightmap>` node. Equivalent to :ref:`BakedLightmapData.octree<class_BakedLightmapData_property_octree>`.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_lightmap_capture_set_octree_cell_subdiv:
|
|||
|
|
|
|||
|
|
- void **lightmap_capture_set_octree_cell_subdiv** **(** :ref:`RID<class_RID>` capture, :ref:`int<class_int>` subdiv **)**
|
|||
|
|
|
|||
|
|
Sets the subdivision level of this lightmap capture's octree. Equivalent to :ref:`BakedLightmapData.cell_subdiv<class_BakedLightmapData_property_cell_subdiv>`.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_lightmap_capture_set_octree_cell_transform:
|
|||
|
|
|
|||
|
|
- void **lightmap_capture_set_octree_cell_transform** **(** :ref:`RID<class_RID>` capture, :ref:`Transform<class_Transform>` xform **)**
|
|||
|
|
|
|||
|
|
Sets the octree cell transform for this lightmap capture's octree. Equivalent to :ref:`BakedLightmapData.cell_space_transform<class_BakedLightmapData_property_cell_space_transform>`.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_make_sphere_mesh:
|
|||
|
|
|
|||
|
|
- :ref:`RID<class_RID>` **make_sphere_mesh** **(** :ref:`int<class_int>` latitudes, :ref:`int<class_int>` longitudes, :ref:`float<class_float>` radius **)**
|
|||
|
|
|
|||
|
|
Returns a mesh of a sphere with the given amount of horizontal and vertical subdivisions.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_material_create:
|
|||
|
|
|
|||
|
|
- :ref:`RID<class_RID>` **material_create** **(** **)**
|
|||
|
|
|
|||
|
|
Creates an empty material and adds it to the VisualServer. It can be accessed with the RID that is returned. This RID will be used in all ``material_*`` VisualServer functions.
|
|||
|
|
|
|||
|
|
Once finished with your RID, you will want to free the RID using the VisualServer's :ref:`free_rid<class_VisualServer_method_free_rid>` static method.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_material_get_param:
|
|||
|
|
|
|||
|
|
- :ref:`Variant<class_Variant>` **material_get_param** **(** :ref:`RID<class_RID>` material, :ref:`String<class_String>` parameter **)** |const|
|
|||
|
|
|
|||
|
|
Returns the value of a certain material's parameter.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_material_get_param_default:
|
|||
|
|
|
|||
|
|
- :ref:`Variant<class_Variant>` **material_get_param_default** **(** :ref:`RID<class_RID>` material, :ref:`String<class_String>` parameter **)** |const|
|
|||
|
|
|
|||
|
|
Returns the default value for the param if available. Returns ``null`` otherwise.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_material_get_shader:
|
|||
|
|
|
|||
|
|
- :ref:`RID<class_RID>` **material_get_shader** **(** :ref:`RID<class_RID>` shader_material **)** |const|
|
|||
|
|
|
|||
|
|
Returns the shader of a certain material's shader. Returns an empty RID if the material doesn't have a shader.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_material_set_line_width:
|
|||
|
|
|
|||
|
|
- void **material_set_line_width** **(** :ref:`RID<class_RID>` material, :ref:`float<class_float>` width **)**
|
|||
|
|
|
|||
|
|
Sets a material's line width.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_material_set_next_pass:
|
|||
|
|
|
|||
|
|
- void **material_set_next_pass** **(** :ref:`RID<class_RID>` material, :ref:`RID<class_RID>` next_material **)**
|
|||
|
|
|
|||
|
|
Sets an object's next material.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_material_set_param:
|
|||
|
|
|
|||
|
|
- void **material_set_param** **(** :ref:`RID<class_RID>` material, :ref:`String<class_String>` parameter, :ref:`Variant<class_Variant>` value **)**
|
|||
|
|
|
|||
|
|
Sets a material's parameter.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_material_set_render_priority:
|
|||
|
|
|
|||
|
|
- void **material_set_render_priority** **(** :ref:`RID<class_RID>` material, :ref:`int<class_int>` priority **)**
|
|||
|
|
|
|||
|
|
Sets a material's render priority.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_material_set_shader:
|
|||
|
|
|
|||
|
|
- void **material_set_shader** **(** :ref:`RID<class_RID>` shader_material, :ref:`RID<class_RID>` shader **)**
|
|||
|
|
|
|||
|
|
Sets a shader material's shader.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_mesh_add_surface_from_arrays:
|
|||
|
|
|
|||
|
|
- void **mesh_add_surface_from_arrays** **(** :ref:`RID<class_RID>` mesh, :ref:`PrimitiveType<enum_VisualServer_PrimitiveType>` primitive, :ref:`Array<class_Array>` arrays, :ref:`Array<class_Array>` blend_shapes=[ ], :ref:`int<class_int>` compress_format=2194432 **)**
|
|||
|
|
|
|||
|
|
Adds a surface generated from the Arrays to a mesh. See :ref:`PrimitiveType<enum_VisualServer_PrimitiveType>` constants for types.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_mesh_clear:
|
|||
|
|
|
|||
|
|
- void **mesh_clear** **(** :ref:`RID<class_RID>` mesh **)**
|
|||
|
|
|
|||
|
|
Removes all surfaces from a mesh.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_mesh_create:
|
|||
|
|
|
|||
|
|
- :ref:`RID<class_RID>` **mesh_create** **(** **)**
|
|||
|
|
|
|||
|
|
Creates a new mesh and adds it to the VisualServer. It can be accessed with the RID that is returned. This RID will be used in all ``mesh_*`` VisualServer functions.
|
|||
|
|
|
|||
|
|
Once finished with your RID, you will want to free the RID using the VisualServer's :ref:`free_rid<class_VisualServer_method_free_rid>` static method.
|
|||
|
|
|
|||
|
|
To place in a scene, attach this mesh to an instance using :ref:`instance_set_base<class_VisualServer_method_instance_set_base>` using the returned RID.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_mesh_get_blend_shape_count:
|
|||
|
|
|
|||
|
|
- :ref:`int<class_int>` **mesh_get_blend_shape_count** **(** :ref:`RID<class_RID>` mesh **)** |const|
|
|||
|
|
|
|||
|
|
Returns a mesh's blend shape count.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_mesh_get_blend_shape_mode:
|
|||
|
|
|
|||
|
|
- :ref:`BlendShapeMode<enum_VisualServer_BlendShapeMode>` **mesh_get_blend_shape_mode** **(** :ref:`RID<class_RID>` mesh **)** |const|
|
|||
|
|
|
|||
|
|
Returns a mesh's blend shape mode.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_mesh_get_custom_aabb:
|
|||
|
|
|
|||
|
|
- :ref:`AABB<class_AABB>` **mesh_get_custom_aabb** **(** :ref:`RID<class_RID>` mesh **)** |const|
|
|||
|
|
|
|||
|
|
Returns a mesh's custom aabb.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_mesh_get_surface_count:
|
|||
|
|
|
|||
|
|
- :ref:`int<class_int>` **mesh_get_surface_count** **(** :ref:`RID<class_RID>` mesh **)** |const|
|
|||
|
|
|
|||
|
|
Returns a mesh's number of surfaces.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_mesh_remove_surface:
|
|||
|
|
|
|||
|
|
- void **mesh_remove_surface** **(** :ref:`RID<class_RID>` mesh, :ref:`int<class_int>` index **)**
|
|||
|
|
|
|||
|
|
Removes a mesh's surface.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_mesh_set_blend_shape_count:
|
|||
|
|
|
|||
|
|
- void **mesh_set_blend_shape_count** **(** :ref:`RID<class_RID>` mesh, :ref:`int<class_int>` amount **)**
|
|||
|
|
|
|||
|
|
Sets a mesh's blend shape count.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_mesh_set_blend_shape_mode:
|
|||
|
|
|
|||
|
|
- void **mesh_set_blend_shape_mode** **(** :ref:`RID<class_RID>` mesh, :ref:`BlendShapeMode<enum_VisualServer_BlendShapeMode>` mode **)**
|
|||
|
|
|
|||
|
|
Sets a mesh's blend shape mode.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_mesh_set_custom_aabb:
|
|||
|
|
|
|||
|
|
- void **mesh_set_custom_aabb** **(** :ref:`RID<class_RID>` mesh, :ref:`AABB<class_AABB>` aabb **)**
|
|||
|
|
|
|||
|
|
Sets a mesh's custom aabb.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_mesh_surface_get_aabb:
|
|||
|
|
|
|||
|
|
- :ref:`AABB<class_AABB>` **mesh_surface_get_aabb** **(** :ref:`RID<class_RID>` mesh, :ref:`int<class_int>` surface **)** |const|
|
|||
|
|
|
|||
|
|
Returns a mesh's surface's aabb.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_mesh_surface_get_array:
|
|||
|
|
|
|||
|
|
- :ref:`PoolByteArray<class_PoolByteArray>` **mesh_surface_get_array** **(** :ref:`RID<class_RID>` mesh, :ref:`int<class_int>` surface **)** |const|
|
|||
|
|
|
|||
|
|
Returns a mesh's surface's vertex buffer.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_mesh_surface_get_array_index_len:
|
|||
|
|
|
|||
|
|
- :ref:`int<class_int>` **mesh_surface_get_array_index_len** **(** :ref:`RID<class_RID>` mesh, :ref:`int<class_int>` surface **)** |const|
|
|||
|
|
|
|||
|
|
Returns a mesh's surface's amount of indices.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_mesh_surface_get_array_len:
|
|||
|
|
|
|||
|
|
- :ref:`int<class_int>` **mesh_surface_get_array_len** **(** :ref:`RID<class_RID>` mesh, :ref:`int<class_int>` surface **)** |const|
|
|||
|
|
|
|||
|
|
Returns a mesh's surface's amount of vertices.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_mesh_surface_get_arrays:
|
|||
|
|
|
|||
|
|
- :ref:`Array<class_Array>` **mesh_surface_get_arrays** **(** :ref:`RID<class_RID>` mesh, :ref:`int<class_int>` surface **)** |const|
|
|||
|
|
|
|||
|
|
Returns a mesh's surface's buffer arrays.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_mesh_surface_get_blend_shape_arrays:
|
|||
|
|
|
|||
|
|
- :ref:`Array<class_Array>` **mesh_surface_get_blend_shape_arrays** **(** :ref:`RID<class_RID>` mesh, :ref:`int<class_int>` surface **)** |const|
|
|||
|
|
|
|||
|
|
Returns a mesh's surface's arrays for blend shapes.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_mesh_surface_get_format:
|
|||
|
|
|
|||
|
|
- :ref:`int<class_int>` **mesh_surface_get_format** **(** :ref:`RID<class_RID>` mesh, :ref:`int<class_int>` surface **)** |const|
|
|||
|
|
|
|||
|
|
Returns the format of a mesh's surface.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_mesh_surface_get_format_offset:
|
|||
|
|
|
|||
|
|
- :ref:`int<class_int>` **mesh_surface_get_format_offset** **(** :ref:`int<class_int>` format, :ref:`int<class_int>` vertex_len, :ref:`int<class_int>` index_len, :ref:`int<class_int>` array_index **)** |const|
|
|||
|
|
|
|||
|
|
Function is unused in Godot 3.x.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_mesh_surface_get_format_stride:
|
|||
|
|
|
|||
|
|
- :ref:`int<class_int>` **mesh_surface_get_format_stride** **(** :ref:`int<class_int>` format, :ref:`int<class_int>` vertex_len, :ref:`int<class_int>` index_len, :ref:`int<class_int>` array_index **)** |const|
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_mesh_surface_get_index_array:
|
|||
|
|
|
|||
|
|
- :ref:`PoolByteArray<class_PoolByteArray>` **mesh_surface_get_index_array** **(** :ref:`RID<class_RID>` mesh, :ref:`int<class_int>` surface **)** |const|
|
|||
|
|
|
|||
|
|
Returns a mesh's surface's index buffer.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_mesh_surface_get_material:
|
|||
|
|
|
|||
|
|
- :ref:`RID<class_RID>` **mesh_surface_get_material** **(** :ref:`RID<class_RID>` mesh, :ref:`int<class_int>` surface **)** |const|
|
|||
|
|
|
|||
|
|
Returns a mesh's surface's material.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_mesh_surface_get_primitive_type:
|
|||
|
|
|
|||
|
|
- :ref:`PrimitiveType<enum_VisualServer_PrimitiveType>` **mesh_surface_get_primitive_type** **(** :ref:`RID<class_RID>` mesh, :ref:`int<class_int>` surface **)** |const|
|
|||
|
|
|
|||
|
|
Returns the primitive type of a mesh's surface.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_mesh_surface_get_skeleton_aabb:
|
|||
|
|
|
|||
|
|
- :ref:`Array<class_Array>` **mesh_surface_get_skeleton_aabb** **(** :ref:`RID<class_RID>` mesh, :ref:`int<class_int>` surface **)** |const|
|
|||
|
|
|
|||
|
|
Returns the aabb of a mesh's surface's skeleton.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_mesh_surface_set_material:
|
|||
|
|
|
|||
|
|
- void **mesh_surface_set_material** **(** :ref:`RID<class_RID>` mesh, :ref:`int<class_int>` surface, :ref:`RID<class_RID>` material **)**
|
|||
|
|
|
|||
|
|
Sets a mesh's surface's material.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_mesh_surface_update_region:
|
|||
|
|
|
|||
|
|
- void **mesh_surface_update_region** **(** :ref:`RID<class_RID>` mesh, :ref:`int<class_int>` surface, :ref:`int<class_int>` offset, :ref:`PoolByteArray<class_PoolByteArray>` data **)**
|
|||
|
|
|
|||
|
|
Updates a specific region of a vertex buffer for the specified surface. Warning: this function alters the vertex buffer directly with no safety mechanisms, you can easily corrupt your mesh.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_multimesh_allocate:
|
|||
|
|
|
|||
|
|
- void **multimesh_allocate** **(** :ref:`RID<class_RID>` multimesh, :ref:`int<class_int>` instances, :ref:`MultimeshTransformFormat<enum_VisualServer_MultimeshTransformFormat>` transform_format, :ref:`MultimeshColorFormat<enum_VisualServer_MultimeshColorFormat>` color_format, :ref:`MultimeshCustomDataFormat<enum_VisualServer_MultimeshCustomDataFormat>` custom_data_format=0 **)**
|
|||
|
|
|
|||
|
|
Allocates space for the multimesh data. Format parameters determine how the data will be stored by OpenGL. See :ref:`MultimeshTransformFormat<enum_VisualServer_MultimeshTransformFormat>`, :ref:`MultimeshColorFormat<enum_VisualServer_MultimeshColorFormat>`, and :ref:`MultimeshCustomDataFormat<enum_VisualServer_MultimeshCustomDataFormat>` for usage. Equivalent to :ref:`MultiMesh.instance_count<class_MultiMesh_property_instance_count>`.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_multimesh_create:
|
|||
|
|
|
|||
|
|
- :ref:`RID<class_RID>` **multimesh_create** **(** **)**
|
|||
|
|
|
|||
|
|
Creates a new multimesh on the VisualServer and returns an :ref:`RID<class_RID>` handle. This RID will be used in all ``multimesh_*`` VisualServer functions.
|
|||
|
|
|
|||
|
|
Once finished with your RID, you will want to free the RID using the VisualServer's :ref:`free_rid<class_VisualServer_method_free_rid>` static method.
|
|||
|
|
|
|||
|
|
To place in a scene, attach this multimesh to an instance using :ref:`instance_set_base<class_VisualServer_method_instance_set_base>` using the returned RID.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_multimesh_get_aabb:
|
|||
|
|
|
|||
|
|
- :ref:`AABB<class_AABB>` **multimesh_get_aabb** **(** :ref:`RID<class_RID>` multimesh **)** |const|
|
|||
|
|
|
|||
|
|
Calculates and returns the axis-aligned bounding box that encloses all instances within the multimesh.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_multimesh_get_instance_count:
|
|||
|
|
|
|||
|
|
- :ref:`int<class_int>` **multimesh_get_instance_count** **(** :ref:`RID<class_RID>` multimesh **)** |const|
|
|||
|
|
|
|||
|
|
Returns the number of instances allocated for this multimesh.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_multimesh_get_mesh:
|
|||
|
|
|
|||
|
|
- :ref:`RID<class_RID>` **multimesh_get_mesh** **(** :ref:`RID<class_RID>` multimesh **)** |const|
|
|||
|
|
|
|||
|
|
Returns the RID of the mesh that will be used in drawing this multimesh.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_multimesh_get_visible_instances:
|
|||
|
|
|
|||
|
|
- :ref:`int<class_int>` **multimesh_get_visible_instances** **(** :ref:`RID<class_RID>` multimesh **)** |const|
|
|||
|
|
|
|||
|
|
Returns the number of visible instances for this multimesh.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_multimesh_instance_get_color:
|
|||
|
|
|
|||
|
|
- :ref:`Color<class_Color>` **multimesh_instance_get_color** **(** :ref:`RID<class_RID>` multimesh, :ref:`int<class_int>` index **)** |const|
|
|||
|
|
|
|||
|
|
Returns the color by which the specified instance will be modulated.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_multimesh_instance_get_custom_data:
|
|||
|
|
|
|||
|
|
- :ref:`Color<class_Color>` **multimesh_instance_get_custom_data** **(** :ref:`RID<class_RID>` multimesh, :ref:`int<class_int>` index **)** |const|
|
|||
|
|
|
|||
|
|
Returns the custom data associated with the specified instance.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_multimesh_instance_get_transform:
|
|||
|
|
|
|||
|
|
- :ref:`Transform<class_Transform>` **multimesh_instance_get_transform** **(** :ref:`RID<class_RID>` multimesh, :ref:`int<class_int>` index **)** |const|
|
|||
|
|
|
|||
|
|
Returns the :ref:`Transform<class_Transform>` of the specified instance.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_multimesh_instance_get_transform_2d:
|
|||
|
|
|
|||
|
|
- :ref:`Transform2D<class_Transform2D>` **multimesh_instance_get_transform_2d** **(** :ref:`RID<class_RID>` multimesh, :ref:`int<class_int>` index **)** |const|
|
|||
|
|
|
|||
|
|
Returns the :ref:`Transform2D<class_Transform2D>` of the specified instance. For use when the multimesh is set to use 2D transforms.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_multimesh_instance_reset_physics_interpolation:
|
|||
|
|
|
|||
|
|
- void **multimesh_instance_reset_physics_interpolation** **(** :ref:`RID<class_RID>` multimesh, :ref:`int<class_int>` index **)**
|
|||
|
|
|
|||
|
|
Prevents physics interpolation for the specified instance during the current physics tick.
|
|||
|
|
|
|||
|
|
This is useful when moving an instance to a new location, to give an instantaneous change rather than interpolation from the previous location.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_multimesh_instance_set_color:
|
|||
|
|
|
|||
|
|
- void **multimesh_instance_set_color** **(** :ref:`RID<class_RID>` multimesh, :ref:`int<class_int>` index, :ref:`Color<class_Color>` color **)**
|
|||
|
|
|
|||
|
|
Sets the color by which this instance will be modulated. Equivalent to :ref:`MultiMesh.set_instance_color<class_MultiMesh_method_set_instance_color>`.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_multimesh_instance_set_custom_data:
|
|||
|
|
|
|||
|
|
- void **multimesh_instance_set_custom_data** **(** :ref:`RID<class_RID>` multimesh, :ref:`int<class_int>` index, :ref:`Color<class_Color>` custom_data **)**
|
|||
|
|
|
|||
|
|
Sets the custom data for this instance. Custom data is passed as a :ref:`Color<class_Color>`, but is interpreted as a ``vec4`` in the shader. Equivalent to :ref:`MultiMesh.set_instance_custom_data<class_MultiMesh_method_set_instance_custom_data>`.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_multimesh_instance_set_transform:
|
|||
|
|
|
|||
|
|
- void **multimesh_instance_set_transform** **(** :ref:`RID<class_RID>` multimesh, :ref:`int<class_int>` index, :ref:`Transform<class_Transform>` transform **)**
|
|||
|
|
|
|||
|
|
Sets the :ref:`Transform<class_Transform>` for this instance. Equivalent to :ref:`MultiMesh.set_instance_transform<class_MultiMesh_method_set_instance_transform>`.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_multimesh_instance_set_transform_2d:
|
|||
|
|
|
|||
|
|
- void **multimesh_instance_set_transform_2d** **(** :ref:`RID<class_RID>` multimesh, :ref:`int<class_int>` index, :ref:`Transform2D<class_Transform2D>` transform **)**
|
|||
|
|
|
|||
|
|
Sets the :ref:`Transform2D<class_Transform2D>` for this instance. For use when multimesh is used in 2D. Equivalent to :ref:`MultiMesh.set_instance_transform_2d<class_MultiMesh_method_set_instance_transform_2d>`.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_multimesh_set_as_bulk_array:
|
|||
|
|
|
|||
|
|
- void **multimesh_set_as_bulk_array** **(** :ref:`RID<class_RID>` multimesh, :ref:`PoolRealArray<class_PoolRealArray>` array **)**
|
|||
|
|
|
|||
|
|
Sets all data related to the instances in one go. This is especially useful when loading the data from disk or preparing the data from GDNative.
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
All data is packed in one large float array. An array may look like this: Transform for instance 1, color data for instance 1, custom data for instance 1, transform for instance 2, color data for instance 2, etc.
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
\ :ref:`Transform<class_Transform>` is stored as 12 floats, :ref:`Transform2D<class_Transform2D>` is stored as 8 floats, ``COLOR_8BIT`` / ``CUSTOM_DATA_8BIT`` is stored as 1 float (4 bytes as is) and ``COLOR_FLOAT`` / ``CUSTOM_DATA_FLOAT`` is stored as 4 floats.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_multimesh_set_as_bulk_array_interpolated:
|
|||
|
|
|
|||
|
|
- void **multimesh_set_as_bulk_array_interpolated** **(** :ref:`RID<class_RID>` multimesh, :ref:`PoolRealArray<class_PoolRealArray>` array, :ref:`PoolRealArray<class_PoolRealArray>` array_previous **)**
|
|||
|
|
|
|||
|
|
Alternative version of :ref:`multimesh_set_as_bulk_array<class_VisualServer_method_multimesh_set_as_bulk_array>` for use with physics interpolation.
|
|||
|
|
|
|||
|
|
Takes both an array of current data and an array of data for the previous physics tick.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_multimesh_set_mesh:
|
|||
|
|
|
|||
|
|
- void **multimesh_set_mesh** **(** :ref:`RID<class_RID>` multimesh, :ref:`RID<class_RID>` mesh **)**
|
|||
|
|
|
|||
|
|
Sets the mesh to be drawn by the multimesh. Equivalent to :ref:`MultiMesh.mesh<class_MultiMesh_property_mesh>`.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_multimesh_set_physics_interpolated:
|
|||
|
|
|
|||
|
|
- void **multimesh_set_physics_interpolated** **(** :ref:`RID<class_RID>` multimesh, :ref:`bool<class_bool>` interpolated **)**
|
|||
|
|
|
|||
|
|
Turns on and off physics interpolation for the :ref:`MultiMesh<class_MultiMesh>`.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_multimesh_set_physics_interpolation_quality:
|
|||
|
|
|
|||
|
|
- void **multimesh_set_physics_interpolation_quality** **(** :ref:`RID<class_RID>` multimesh, :ref:`MultimeshPhysicsInterpolationQuality<enum_VisualServer_MultimeshPhysicsInterpolationQuality>` quality **)**
|
|||
|
|
|
|||
|
|
Sets the physics interpolation quality for the :ref:`MultiMesh<class_MultiMesh>`.
|
|||
|
|
|
|||
|
|
A value of ``0`` gives fast but low quality interpolation, a value of ``1`` gives slower but higher quality interpolation.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_multimesh_set_visible_instances:
|
|||
|
|
|
|||
|
|
- void **multimesh_set_visible_instances** **(** :ref:`RID<class_RID>` multimesh, :ref:`int<class_int>` visible **)**
|
|||
|
|
|
|||
|
|
Sets the number of instances visible at a given time. If -1, all instances that have been allocated are drawn. Equivalent to :ref:`MultiMesh.visible_instance_count<class_MultiMesh_property_visible_instance_count>`.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_omni_light_create:
|
|||
|
|
|
|||
|
|
- :ref:`RID<class_RID>` **omni_light_create** **(** **)**
|
|||
|
|
|
|||
|
|
Creates a new omni light and adds it to the VisualServer. It can be accessed with the RID that is returned. This RID can be used in most ``light_*`` VisualServer functions.
|
|||
|
|
|
|||
|
|
Once finished with your RID, you will want to free the RID using the VisualServer's :ref:`free_rid<class_VisualServer_method_free_rid>` static method.
|
|||
|
|
|
|||
|
|
To place in a scene, attach this omni light to an instance using :ref:`instance_set_base<class_VisualServer_method_instance_set_base>` using the returned RID.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_particles_create:
|
|||
|
|
|
|||
|
|
- :ref:`RID<class_RID>` **particles_create** **(** **)**
|
|||
|
|
|
|||
|
|
Creates a particle system and adds it to the VisualServer. It can be accessed with the RID that is returned. This RID will be used in all ``particles_*`` VisualServer functions.
|
|||
|
|
|
|||
|
|
Once finished with your RID, you will want to free the RID using the VisualServer's :ref:`free_rid<class_VisualServer_method_free_rid>` static method.
|
|||
|
|
|
|||
|
|
To place in a scene, attach these particles to an instance using :ref:`instance_set_base<class_VisualServer_method_instance_set_base>` using the returned RID.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_particles_get_current_aabb:
|
|||
|
|
|
|||
|
|
- :ref:`AABB<class_AABB>` **particles_get_current_aabb** **(** :ref:`RID<class_RID>` particles **)**
|
|||
|
|
|
|||
|
|
Calculates and returns the axis-aligned bounding box that contains all the particles. Equivalent to :ref:`Particles.capture_aabb<class_Particles_method_capture_aabb>`.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_particles_get_emitting:
|
|||
|
|
|
|||
|
|
- :ref:`bool<class_bool>` **particles_get_emitting** **(** :ref:`RID<class_RID>` particles **)**
|
|||
|
|
|
|||
|
|
Returns ``true`` if particles are currently set to emitting.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_particles_is_inactive:
|
|||
|
|
|
|||
|
|
- :ref:`bool<class_bool>` **particles_is_inactive** **(** :ref:`RID<class_RID>` particles **)**
|
|||
|
|
|
|||
|
|
Returns ``true`` if particles are not emitting and particles are set to inactive.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_particles_request_process:
|
|||
|
|
|
|||
|
|
- void **particles_request_process** **(** :ref:`RID<class_RID>` particles **)**
|
|||
|
|
|
|||
|
|
Add particle system to list of particle systems that need to be updated. Update will take place on the next frame, or on the next call to :ref:`instances_cull_aabb<class_VisualServer_method_instances_cull_aabb>`, :ref:`instances_cull_convex<class_VisualServer_method_instances_cull_convex>`, or :ref:`instances_cull_ray<class_VisualServer_method_instances_cull_ray>`.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_particles_restart:
|
|||
|
|
|
|||
|
|
- void **particles_restart** **(** :ref:`RID<class_RID>` particles **)**
|
|||
|
|
|
|||
|
|
Reset the particles on the next update. Equivalent to :ref:`Particles.restart<class_Particles_method_restart>`.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_particles_set_amount:
|
|||
|
|
|
|||
|
|
- void **particles_set_amount** **(** :ref:`RID<class_RID>` particles, :ref:`int<class_int>` amount **)**
|
|||
|
|
|
|||
|
|
Sets the number of particles to be drawn and allocates the memory for them. Equivalent to :ref:`Particles.amount<class_Particles_property_amount>`.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_particles_set_custom_aabb:
|
|||
|
|
|
|||
|
|
- void **particles_set_custom_aabb** **(** :ref:`RID<class_RID>` particles, :ref:`AABB<class_AABB>` aabb **)**
|
|||
|
|
|
|||
|
|
Sets a custom axis-aligned bounding box for the particle system. Equivalent to :ref:`Particles.visibility_aabb<class_Particles_property_visibility_aabb>`.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_particles_set_draw_order:
|
|||
|
|
|
|||
|
|
- void **particles_set_draw_order** **(** :ref:`RID<class_RID>` particles, :ref:`ParticlesDrawOrder<enum_VisualServer_ParticlesDrawOrder>` order **)**
|
|||
|
|
|
|||
|
|
Sets the draw order of the particles to one of the named enums from :ref:`ParticlesDrawOrder<enum_VisualServer_ParticlesDrawOrder>`. See :ref:`ParticlesDrawOrder<enum_VisualServer_ParticlesDrawOrder>` for options. Equivalent to :ref:`Particles.draw_order<class_Particles_property_draw_order>`.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_particles_set_draw_pass_mesh:
|
|||
|
|
|
|||
|
|
- void **particles_set_draw_pass_mesh** **(** :ref:`RID<class_RID>` particles, :ref:`int<class_int>` pass, :ref:`RID<class_RID>` mesh **)**
|
|||
|
|
|
|||
|
|
Sets the mesh to be used for the specified draw pass. Equivalent to :ref:`Particles.draw_pass_1<class_Particles_property_draw_pass_1>`, :ref:`Particles.draw_pass_2<class_Particles_property_draw_pass_2>`, :ref:`Particles.draw_pass_3<class_Particles_property_draw_pass_3>`, and :ref:`Particles.draw_pass_4<class_Particles_property_draw_pass_4>`.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_particles_set_draw_passes:
|
|||
|
|
|
|||
|
|
- void **particles_set_draw_passes** **(** :ref:`RID<class_RID>` particles, :ref:`int<class_int>` count **)**
|
|||
|
|
|
|||
|
|
Sets the number of draw passes to use. Equivalent to :ref:`Particles.draw_passes<class_Particles_property_draw_passes>`.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_particles_set_emission_transform:
|
|||
|
|
|
|||
|
|
- void **particles_set_emission_transform** **(** :ref:`RID<class_RID>` particles, :ref:`Transform<class_Transform>` transform **)**
|
|||
|
|
|
|||
|
|
Sets the :ref:`Transform<class_Transform>` that will be used by the particles when they first emit.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_particles_set_emitting:
|
|||
|
|
|
|||
|
|
- void **particles_set_emitting** **(** :ref:`RID<class_RID>` particles, :ref:`bool<class_bool>` emitting **)**
|
|||
|
|
|
|||
|
|
If ``true``, particles will emit over time. Setting to false does not reset the particles, but only stops their emission. Equivalent to :ref:`Particles.emitting<class_Particles_property_emitting>`.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_particles_set_explosiveness_ratio:
|
|||
|
|
|
|||
|
|
- void **particles_set_explosiveness_ratio** **(** :ref:`RID<class_RID>` particles, :ref:`float<class_float>` ratio **)**
|
|||
|
|
|
|||
|
|
Sets the explosiveness ratio. Equivalent to :ref:`Particles.explosiveness<class_Particles_property_explosiveness>`.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_particles_set_fixed_fps:
|
|||
|
|
|
|||
|
|
- void **particles_set_fixed_fps** **(** :ref:`RID<class_RID>` particles, :ref:`int<class_int>` fps **)**
|
|||
|
|
|
|||
|
|
Sets the frame rate that the particle system rendering will be fixed to. Equivalent to :ref:`Particles.fixed_fps<class_Particles_property_fixed_fps>`.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_particles_set_fractional_delta:
|
|||
|
|
|
|||
|
|
- void **particles_set_fractional_delta** **(** :ref:`RID<class_RID>` particles, :ref:`bool<class_bool>` enable **)**
|
|||
|
|
|
|||
|
|
If ``true``, uses fractional delta which smooths the movement of the particles. Equivalent to :ref:`Particles.fract_delta<class_Particles_property_fract_delta>`.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_particles_set_lifetime:
|
|||
|
|
|
|||
|
|
- void **particles_set_lifetime** **(** :ref:`RID<class_RID>` particles, :ref:`float<class_float>` lifetime **)**
|
|||
|
|
|
|||
|
|
Sets the lifetime of each particle in the system. Equivalent to :ref:`Particles.lifetime<class_Particles_property_lifetime>`.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_particles_set_one_shot:
|
|||
|
|
|
|||
|
|
- void **particles_set_one_shot** **(** :ref:`RID<class_RID>` particles, :ref:`bool<class_bool>` one_shot **)**
|
|||
|
|
|
|||
|
|
If ``true``, particles will emit once and then stop. Equivalent to :ref:`Particles.one_shot<class_Particles_property_one_shot>`.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_particles_set_pre_process_time:
|
|||
|
|
|
|||
|
|
- void **particles_set_pre_process_time** **(** :ref:`RID<class_RID>` particles, :ref:`float<class_float>` time **)**
|
|||
|
|
|
|||
|
|
Sets the preprocess time for the particles' animation. This lets you delay starting an animation until after the particles have begun emitting. Equivalent to :ref:`Particles.preprocess<class_Particles_property_preprocess>`.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_particles_set_process_material:
|
|||
|
|
|
|||
|
|
- void **particles_set_process_material** **(** :ref:`RID<class_RID>` particles, :ref:`RID<class_RID>` material **)**
|
|||
|
|
|
|||
|
|
Sets the material for processing the particles.
|
|||
|
|
|
|||
|
|
\ **Note:** This is not the material used to draw the materials. Equivalent to :ref:`Particles.process_material<class_Particles_property_process_material>`.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_particles_set_randomness_ratio:
|
|||
|
|
|
|||
|
|
- void **particles_set_randomness_ratio** **(** :ref:`RID<class_RID>` particles, :ref:`float<class_float>` ratio **)**
|
|||
|
|
|
|||
|
|
Sets the emission randomness ratio. This randomizes the emission of particles within their phase. Equivalent to :ref:`Particles.randomness<class_Particles_property_randomness>`.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_particles_set_speed_scale:
|
|||
|
|
|
|||
|
|
- void **particles_set_speed_scale** **(** :ref:`RID<class_RID>` particles, :ref:`float<class_float>` scale **)**
|
|||
|
|
|
|||
|
|
Sets the speed scale of the particle system. Equivalent to :ref:`Particles.speed_scale<class_Particles_property_speed_scale>`.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_particles_set_use_local_coordinates:
|
|||
|
|
|
|||
|
|
- void **particles_set_use_local_coordinates** **(** :ref:`RID<class_RID>` particles, :ref:`bool<class_bool>` enable **)**
|
|||
|
|
|
|||
|
|
If ``true``, particles use local coordinates. If ``false`` they use global coordinates. Equivalent to :ref:`Particles.local_coords<class_Particles_property_local_coords>`.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_reflection_probe_create:
|
|||
|
|
|
|||
|
|
- :ref:`RID<class_RID>` **reflection_probe_create** **(** **)**
|
|||
|
|
|
|||
|
|
Creates a reflection probe and adds it to the VisualServer. It can be accessed with the RID that is returned. This RID will be used in all ``reflection_probe_*`` VisualServer functions.
|
|||
|
|
|
|||
|
|
Once finished with your RID, you will want to free the RID using the VisualServer's :ref:`free_rid<class_VisualServer_method_free_rid>` static method.
|
|||
|
|
|
|||
|
|
To place in a scene, attach this reflection probe to an instance using :ref:`instance_set_base<class_VisualServer_method_instance_set_base>` using the returned RID.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_reflection_probe_set_as_interior:
|
|||
|
|
|
|||
|
|
- void **reflection_probe_set_as_interior** **(** :ref:`RID<class_RID>` probe, :ref:`bool<class_bool>` enable **)**
|
|||
|
|
|
|||
|
|
If ``true``, reflections will ignore sky contribution. Equivalent to :ref:`ReflectionProbe.interior_enable<class_ReflectionProbe_property_interior_enable>`.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_reflection_probe_set_cull_mask:
|
|||
|
|
|
|||
|
|
- void **reflection_probe_set_cull_mask** **(** :ref:`RID<class_RID>` probe, :ref:`int<class_int>` layers **)**
|
|||
|
|
|
|||
|
|
Sets the render cull mask for this reflection probe. Only instances with a matching cull mask will be rendered by this probe. Equivalent to :ref:`ReflectionProbe.cull_mask<class_ReflectionProbe_property_cull_mask>`.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_reflection_probe_set_enable_box_projection:
|
|||
|
|
|
|||
|
|
- void **reflection_probe_set_enable_box_projection** **(** :ref:`RID<class_RID>` probe, :ref:`bool<class_bool>` enable **)**
|
|||
|
|
|
|||
|
|
If ``true``, uses box projection. This can make reflections look more correct in certain situations. Equivalent to :ref:`ReflectionProbe.box_projection<class_ReflectionProbe_property_box_projection>`.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_reflection_probe_set_enable_shadows:
|
|||
|
|
|
|||
|
|
- void **reflection_probe_set_enable_shadows** **(** :ref:`RID<class_RID>` probe, :ref:`bool<class_bool>` enable **)**
|
|||
|
|
|
|||
|
|
If ``true``, computes shadows in the reflection probe. This makes the reflection much slower to compute. Equivalent to :ref:`ReflectionProbe.enable_shadows<class_ReflectionProbe_property_enable_shadows>`.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_reflection_probe_set_extents:
|
|||
|
|
|
|||
|
|
- void **reflection_probe_set_extents** **(** :ref:`RID<class_RID>` probe, :ref:`Vector3<class_Vector3>` extents **)**
|
|||
|
|
|
|||
|
|
Sets the size of the area that the reflection probe will capture. Equivalent to :ref:`ReflectionProbe.extents<class_ReflectionProbe_property_extents>`.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_reflection_probe_set_intensity:
|
|||
|
|
|
|||
|
|
- void **reflection_probe_set_intensity** **(** :ref:`RID<class_RID>` probe, :ref:`float<class_float>` intensity **)**
|
|||
|
|
|
|||
|
|
Sets the intensity of the reflection probe. Intensity modulates the strength of the reflection. Equivalent to :ref:`ReflectionProbe.intensity<class_ReflectionProbe_property_intensity>`.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_reflection_probe_set_interior_ambient:
|
|||
|
|
|
|||
|
|
- void **reflection_probe_set_interior_ambient** **(** :ref:`RID<class_RID>` probe, :ref:`Color<class_Color>` color **)**
|
|||
|
|
|
|||
|
|
Sets the ambient light color for this reflection probe when set to interior mode. Equivalent to :ref:`ReflectionProbe.interior_ambient_color<class_ReflectionProbe_property_interior_ambient_color>`.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_reflection_probe_set_interior_ambient_energy:
|
|||
|
|
|
|||
|
|
- void **reflection_probe_set_interior_ambient_energy** **(** :ref:`RID<class_RID>` probe, :ref:`float<class_float>` energy **)**
|
|||
|
|
|
|||
|
|
Sets the energy multiplier for this reflection probes ambient light contribution when set to interior mode. Equivalent to :ref:`ReflectionProbe.interior_ambient_energy<class_ReflectionProbe_property_interior_ambient_energy>`.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_reflection_probe_set_interior_ambient_probe_contribution:
|
|||
|
|
|
|||
|
|
- void **reflection_probe_set_interior_ambient_probe_contribution** **(** :ref:`RID<class_RID>` probe, :ref:`float<class_float>` contrib **)**
|
|||
|
|
|
|||
|
|
Sets the contribution value for how much the reflection affects the ambient light for this reflection probe when set to interior mode. Useful so that ambient light matches the color of the room. Equivalent to :ref:`ReflectionProbe.interior_ambient_contrib<class_ReflectionProbe_property_interior_ambient_contrib>`.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_reflection_probe_set_max_distance:
|
|||
|
|
|
|||
|
|
- void **reflection_probe_set_max_distance** **(** :ref:`RID<class_RID>` probe, :ref:`float<class_float>` distance **)**
|
|||
|
|
|
|||
|
|
Sets the max distance away from the probe an object can be before it is culled. Equivalent to :ref:`ReflectionProbe.max_distance<class_ReflectionProbe_property_max_distance>`.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_reflection_probe_set_origin_offset:
|
|||
|
|
|
|||
|
|
- void **reflection_probe_set_origin_offset** **(** :ref:`RID<class_RID>` probe, :ref:`Vector3<class_Vector3>` offset **)**
|
|||
|
|
|
|||
|
|
Sets the origin offset to be used when this reflection probe is in box project mode. Equivalent to :ref:`ReflectionProbe.origin_offset<class_ReflectionProbe_property_origin_offset>`.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_reflection_probe_set_update_mode:
|
|||
|
|
|
|||
|
|
- void **reflection_probe_set_update_mode** **(** :ref:`RID<class_RID>` probe, :ref:`ReflectionProbeUpdateMode<enum_VisualServer_ReflectionProbeUpdateMode>` mode **)**
|
|||
|
|
|
|||
|
|
Sets how often the reflection probe updates. Can either be once or every frame. See :ref:`ReflectionProbeUpdateMode<enum_VisualServer_ReflectionProbeUpdateMode>` for options.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_request_frame_drawn_callback:
|
|||
|
|
|
|||
|
|
- void **request_frame_drawn_callback** **(** :ref:`Object<class_Object>` where, :ref:`String<class_String>` method, :ref:`Variant<class_Variant>` userdata **)**
|
|||
|
|
|
|||
|
|
Schedules a callback to the corresponding named ``method`` on ``where`` after a frame has been drawn.
|
|||
|
|
|
|||
|
|
The callback method must use only 1 argument which will be called with ``userdata``.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_scenario_create:
|
|||
|
|
|
|||
|
|
- :ref:`RID<class_RID>` **scenario_create** **(** **)**
|
|||
|
|
|
|||
|
|
Creates a scenario and adds it to the VisualServer. It can be accessed with the RID that is returned. This RID will be used in all ``scenario_*`` VisualServer functions.
|
|||
|
|
|
|||
|
|
Once finished with your RID, you will want to free the RID using the VisualServer's :ref:`free_rid<class_VisualServer_method_free_rid>` static method.
|
|||
|
|
|
|||
|
|
The scenario is the 3D world that all the visual instances exist in.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_scenario_set_debug:
|
|||
|
|
|
|||
|
|
- void **scenario_set_debug** **(** :ref:`RID<class_RID>` scenario, :ref:`ScenarioDebugMode<enum_VisualServer_ScenarioDebugMode>` debug_mode **)**
|
|||
|
|
|
|||
|
|
Sets the :ref:`ScenarioDebugMode<enum_VisualServer_ScenarioDebugMode>` for this scenario. See :ref:`ScenarioDebugMode<enum_VisualServer_ScenarioDebugMode>` for options.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_scenario_set_environment:
|
|||
|
|
|
|||
|
|
- void **scenario_set_environment** **(** :ref:`RID<class_RID>` scenario, :ref:`RID<class_RID>` environment **)**
|
|||
|
|
|
|||
|
|
Sets the environment that will be used with this scenario.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_scenario_set_fallback_environment:
|
|||
|
|
|
|||
|
|
- void **scenario_set_fallback_environment** **(** :ref:`RID<class_RID>` scenario, :ref:`RID<class_RID>` environment **)**
|
|||
|
|
|
|||
|
|
Sets the fallback environment to be used by this scenario. The fallback environment is used if no environment is set. Internally, this is used by the editor to provide a default environment.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_scenario_set_reflection_atlas_size:
|
|||
|
|
|
|||
|
|
- void **scenario_set_reflection_atlas_size** **(** :ref:`RID<class_RID>` scenario, :ref:`int<class_int>` size, :ref:`int<class_int>` subdiv **)**
|
|||
|
|
|
|||
|
|
Sets the size of the reflection atlas shared by all reflection probes in this scenario.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_set_boot_image:
|
|||
|
|
|
|||
|
|
- void **set_boot_image** **(** :ref:`Image<class_Image>` image, :ref:`Color<class_Color>` color, :ref:`bool<class_bool>` scale, :ref:`bool<class_bool>` use_filter=true **)**
|
|||
|
|
|
|||
|
|
Sets a boot image. The color defines the background color. If ``scale`` is ``true``, the image will be scaled to fit the screen size. If ``use_filter`` is ``true``, the image will be scaled with linear interpolation. If ``use_filter`` is ``false``, the image will be scaled with nearest-neighbor interpolation.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_set_debug_generate_wireframes:
|
|||
|
|
|
|||
|
|
- void **set_debug_generate_wireframes** **(** :ref:`bool<class_bool>` generate **)**
|
|||
|
|
|
|||
|
|
If ``true``, the engine will generate wireframes for use with the wireframe debug mode.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_set_default_clear_color:
|
|||
|
|
|
|||
|
|
- void **set_default_clear_color** **(** :ref:`Color<class_Color>` color **)**
|
|||
|
|
|
|||
|
|
Sets the default clear color which is used when a specific clear color has not been selected.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_set_shader_async_hidden_forbidden:
|
|||
|
|
|
|||
|
|
- void **set_shader_async_hidden_forbidden** **(** :ref:`bool<class_bool>` forbidden **)**
|
|||
|
|
|
|||
|
|
If asynchronous shader compilation is enabled, this controls whether :ref:`SpatialMaterial.ASYNC_MODE_HIDDEN<class_SpatialMaterial_constant_ASYNC_MODE_HIDDEN>` is obeyed.
|
|||
|
|
|
|||
|
|
For instance, you may want to enable this temporarily before taking a screenshot. This ensures everything is visible even if shaders with async mode *hidden* are not ready yet.
|
|||
|
|
|
|||
|
|
Reflection probes use this internally to ensure they capture everything regardless the shaders are ready or not.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_set_shader_time_scale:
|
|||
|
|
|
|||
|
|
- void **set_shader_time_scale** **(** :ref:`float<class_float>` scale **)**
|
|||
|
|
|
|||
|
|
Sets the scale to apply to the passage of time for the shaders' ``TIME`` builtin.
|
|||
|
|
|
|||
|
|
The default value is ``1.0``, which means ``TIME`` will count the real time as it goes by, without narrowing or stretching it.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_set_use_occlusion_culling:
|
|||
|
|
|
|||
|
|
- void **set_use_occlusion_culling** **(** :ref:`bool<class_bool>` enable **)**
|
|||
|
|
|
|||
|
|
Enables or disables occlusion culling.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_shader_create:
|
|||
|
|
|
|||
|
|
- :ref:`RID<class_RID>` **shader_create** **(** **)**
|
|||
|
|
|
|||
|
|
Creates an empty shader and adds it to the VisualServer. It can be accessed with the RID that is returned. This RID will be used in all ``shader_*`` VisualServer functions.
|
|||
|
|
|
|||
|
|
Once finished with your RID, you will want to free the RID using the VisualServer's :ref:`free_rid<class_VisualServer_method_free_rid>` static method.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_shader_get_code:
|
|||
|
|
|
|||
|
|
- :ref:`String<class_String>` **shader_get_code** **(** :ref:`RID<class_RID>` shader **)** |const|
|
|||
|
|
|
|||
|
|
Returns a shader's code.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_shader_get_default_texture_param:
|
|||
|
|
|
|||
|
|
- :ref:`RID<class_RID>` **shader_get_default_texture_param** **(** :ref:`RID<class_RID>` shader, :ref:`String<class_String>` name **)** |const|
|
|||
|
|
|
|||
|
|
Returns a default texture from a shader searched by name.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_shader_get_param_list:
|
|||
|
|
|
|||
|
|
- :ref:`Array<class_Array>` **shader_get_param_list** **(** :ref:`RID<class_RID>` shader **)** |const|
|
|||
|
|
|
|||
|
|
Returns the parameters of a shader.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_shader_set_code:
|
|||
|
|
|
|||
|
|
- void **shader_set_code** **(** :ref:`RID<class_RID>` shader, :ref:`String<class_String>` code **)**
|
|||
|
|
|
|||
|
|
Sets a shader's code.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_shader_set_default_texture_param:
|
|||
|
|
|
|||
|
|
- void **shader_set_default_texture_param** **(** :ref:`RID<class_RID>` shader, :ref:`String<class_String>` name, :ref:`RID<class_RID>` texture **)**
|
|||
|
|
|
|||
|
|
Sets a shader's default texture. Overwrites the texture given by name.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_skeleton_allocate:
|
|||
|
|
|
|||
|
|
- void **skeleton_allocate** **(** :ref:`RID<class_RID>` skeleton, :ref:`int<class_int>` bones, :ref:`bool<class_bool>` is_2d_skeleton=false **)**
|
|||
|
|
|
|||
|
|
Allocates the GPU buffers for this skeleton.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_skeleton_bone_get_transform:
|
|||
|
|
|
|||
|
|
- :ref:`Transform<class_Transform>` **skeleton_bone_get_transform** **(** :ref:`RID<class_RID>` skeleton, :ref:`int<class_int>` bone **)** |const|
|
|||
|
|
|
|||
|
|
Returns the :ref:`Transform<class_Transform>` set for a specific bone of this skeleton.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_skeleton_bone_get_transform_2d:
|
|||
|
|
|
|||
|
|
- :ref:`Transform2D<class_Transform2D>` **skeleton_bone_get_transform_2d** **(** :ref:`RID<class_RID>` skeleton, :ref:`int<class_int>` bone **)** |const|
|
|||
|
|
|
|||
|
|
Returns the :ref:`Transform2D<class_Transform2D>` set for a specific bone of this skeleton.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_skeleton_bone_set_transform:
|
|||
|
|
|
|||
|
|
- void **skeleton_bone_set_transform** **(** :ref:`RID<class_RID>` skeleton, :ref:`int<class_int>` bone, :ref:`Transform<class_Transform>` transform **)**
|
|||
|
|
|
|||
|
|
Sets the :ref:`Transform<class_Transform>` for a specific bone of this skeleton.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_skeleton_bone_set_transform_2d:
|
|||
|
|
|
|||
|
|
- void **skeleton_bone_set_transform_2d** **(** :ref:`RID<class_RID>` skeleton, :ref:`int<class_int>` bone, :ref:`Transform2D<class_Transform2D>` transform **)**
|
|||
|
|
|
|||
|
|
Sets the :ref:`Transform2D<class_Transform2D>` for a specific bone of this skeleton.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_skeleton_create:
|
|||
|
|
|
|||
|
|
- :ref:`RID<class_RID>` **skeleton_create** **(** **)**
|
|||
|
|
|
|||
|
|
Creates a skeleton and adds it to the VisualServer. It can be accessed with the RID that is returned. This RID will be used in all ``skeleton_*`` VisualServer functions.
|
|||
|
|
|
|||
|
|
Once finished with your RID, you will want to free the RID using the VisualServer's :ref:`free_rid<class_VisualServer_method_free_rid>` static method.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_skeleton_get_bone_count:
|
|||
|
|
|
|||
|
|
- :ref:`int<class_int>` **skeleton_get_bone_count** **(** :ref:`RID<class_RID>` skeleton **)** |const|
|
|||
|
|
|
|||
|
|
Returns the number of bones allocated for this skeleton.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_sky_create:
|
|||
|
|
|
|||
|
|
- :ref:`RID<class_RID>` **sky_create** **(** **)**
|
|||
|
|
|
|||
|
|
Creates an empty sky and adds it to the VisualServer. It can be accessed with the RID that is returned. This RID will be used in all ``sky_*`` VisualServer functions.
|
|||
|
|
|
|||
|
|
Once finished with your RID, you will want to free the RID using the VisualServer's :ref:`free_rid<class_VisualServer_method_free_rid>` static method.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_sky_set_texture:
|
|||
|
|
|
|||
|
|
- void **sky_set_texture** **(** :ref:`RID<class_RID>` sky, :ref:`RID<class_RID>` cube_map, :ref:`int<class_int>` radiance_size **)**
|
|||
|
|
|
|||
|
|
Sets a sky's texture.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_spot_light_create:
|
|||
|
|
|
|||
|
|
- :ref:`RID<class_RID>` **spot_light_create** **(** **)**
|
|||
|
|
|
|||
|
|
Creates a spot light and adds it to the VisualServer. It can be accessed with the RID that is returned. This RID can be used in most ``light_*`` VisualServer functions.
|
|||
|
|
|
|||
|
|
Once finished with your RID, you will want to free the RID using the VisualServer's :ref:`free_rid<class_VisualServer_method_free_rid>` static method.
|
|||
|
|
|
|||
|
|
To place in a scene, attach this spot light to an instance using :ref:`instance_set_base<class_VisualServer_method_instance_set_base>` using the returned RID.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_sync:
|
|||
|
|
|
|||
|
|
- void **sync** **(** **)**
|
|||
|
|
|
|||
|
|
Not implemented in Godot 3.x.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_texture_allocate:
|
|||
|
|
|
|||
|
|
- void **texture_allocate** **(** :ref:`RID<class_RID>` texture, :ref:`int<class_int>` width, :ref:`int<class_int>` height, :ref:`int<class_int>` depth_3d, :ref:`Format<enum_Image_Format>` format, :ref:`TextureType<enum_VisualServer_TextureType>` type, :ref:`int<class_int>` flags=7 **)**
|
|||
|
|
|
|||
|
|
Allocates the GPU memory for the texture.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_texture_bind:
|
|||
|
|
|
|||
|
|
- void **texture_bind** **(** :ref:`RID<class_RID>` texture, :ref:`int<class_int>` number **)**
|
|||
|
|
|
|||
|
|
Binds the texture to a texture slot.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_texture_create:
|
|||
|
|
|
|||
|
|
- :ref:`RID<class_RID>` **texture_create** **(** **)**
|
|||
|
|
|
|||
|
|
Creates an empty texture and adds it to the VisualServer. It can be accessed with the RID that is returned. This RID will be used in all ``texture_*`` VisualServer functions.
|
|||
|
|
|
|||
|
|
Once finished with your RID, you will want to free the RID using the VisualServer's :ref:`free_rid<class_VisualServer_method_free_rid>` static method.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_texture_create_from_image:
|
|||
|
|
|
|||
|
|
- :ref:`RID<class_RID>` **texture_create_from_image** **(** :ref:`Image<class_Image>` image, :ref:`int<class_int>` flags=7 **)**
|
|||
|
|
|
|||
|
|
Creates a texture, allocates the space for an image, and fills in the image.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_texture_debug_usage:
|
|||
|
|
|
|||
|
|
- :ref:`Array<class_Array>` **texture_debug_usage** **(** **)**
|
|||
|
|
|
|||
|
|
Returns a list of all the textures and their information.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_texture_get_data:
|
|||
|
|
|
|||
|
|
- :ref:`Image<class_Image>` **texture_get_data** **(** :ref:`RID<class_RID>` texture, :ref:`int<class_int>` cube_side=0 **)** |const|
|
|||
|
|
|
|||
|
|
Returns a copy of a texture's image unless it's a CubeMap, in which case it returns the :ref:`RID<class_RID>` of the image at one of the cubes sides.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_texture_get_depth:
|
|||
|
|
|
|||
|
|
- :ref:`int<class_int>` **texture_get_depth** **(** :ref:`RID<class_RID>` texture **)** |const|
|
|||
|
|
|
|||
|
|
Returns the depth of the texture.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_texture_get_flags:
|
|||
|
|
|
|||
|
|
- :ref:`int<class_int>` **texture_get_flags** **(** :ref:`RID<class_RID>` texture **)** |const|
|
|||
|
|
|
|||
|
|
Returns the flags of a texture.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_texture_get_format:
|
|||
|
|
|
|||
|
|
- :ref:`Format<enum_Image_Format>` **texture_get_format** **(** :ref:`RID<class_RID>` texture **)** |const|
|
|||
|
|
|
|||
|
|
Returns the format of the texture's image.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_texture_get_height:
|
|||
|
|
|
|||
|
|
- :ref:`int<class_int>` **texture_get_height** **(** :ref:`RID<class_RID>` texture **)** |const|
|
|||
|
|
|
|||
|
|
Returns the texture's height.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_texture_get_path:
|
|||
|
|
|
|||
|
|
- :ref:`String<class_String>` **texture_get_path** **(** :ref:`RID<class_RID>` texture **)** |const|
|
|||
|
|
|
|||
|
|
Returns the texture's path.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_texture_get_texid:
|
|||
|
|
|
|||
|
|
- :ref:`int<class_int>` **texture_get_texid** **(** :ref:`RID<class_RID>` texture **)** |const|
|
|||
|
|
|
|||
|
|
Returns the opengl id of the texture's image.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_texture_get_type:
|
|||
|
|
|
|||
|
|
- :ref:`TextureType<enum_VisualServer_TextureType>` **texture_get_type** **(** :ref:`RID<class_RID>` texture **)** |const|
|
|||
|
|
|
|||
|
|
Returns the type of the texture, can be any of the :ref:`TextureType<enum_VisualServer_TextureType>`.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_texture_get_width:
|
|||
|
|
|
|||
|
|
- :ref:`int<class_int>` **texture_get_width** **(** :ref:`RID<class_RID>` texture **)** |const|
|
|||
|
|
|
|||
|
|
Returns the texture's width.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_texture_set_data:
|
|||
|
|
|
|||
|
|
- void **texture_set_data** **(** :ref:`RID<class_RID>` texture, :ref:`Image<class_Image>` image, :ref:`int<class_int>` layer=0 **)**
|
|||
|
|
|
|||
|
|
Sets the texture's image data. If it's a CubeMap, it sets the image data at a cube side.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_texture_set_data_partial:
|
|||
|
|
|
|||
|
|
- void **texture_set_data_partial** **(** :ref:`RID<class_RID>` texture, :ref:`Image<class_Image>` image, :ref:`int<class_int>` src_x, :ref:`int<class_int>` src_y, :ref:`int<class_int>` src_w, :ref:`int<class_int>` src_h, :ref:`int<class_int>` dst_x, :ref:`int<class_int>` dst_y, :ref:`int<class_int>` dst_mip, :ref:`int<class_int>` layer=0 **)**
|
|||
|
|
|
|||
|
|
Sets a part of the data for a texture. Warning: this function calls the underlying graphics API directly and may corrupt your texture if used improperly.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_texture_set_flags:
|
|||
|
|
|
|||
|
|
- void **texture_set_flags** **(** :ref:`RID<class_RID>` texture, :ref:`int<class_int>` flags **)**
|
|||
|
|
|
|||
|
|
Sets the texture's flags. See :ref:`TextureFlags<enum_VisualServer_TextureFlags>` for options.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_texture_set_path:
|
|||
|
|
|
|||
|
|
- void **texture_set_path** **(** :ref:`RID<class_RID>` texture, :ref:`String<class_String>` path **)**
|
|||
|
|
|
|||
|
|
Sets the texture's path.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_texture_set_proxy:
|
|||
|
|
|
|||
|
|
- void **texture_set_proxy** **(** :ref:`RID<class_RID>` proxy, :ref:`RID<class_RID>` base **)**
|
|||
|
|
|
|||
|
|
Creates an update link between two textures, similar to how :ref:`ViewportTexture<class_ViewportTexture>`\ s operate. When the base texture is the texture of a :ref:`Viewport<class_Viewport>`, every time the viewport renders a new frame, the proxy texture automatically receives an update.
|
|||
|
|
|
|||
|
|
For example, this code links a generic :ref:`ImageTexture<class_ImageTexture>` to the texture output of the :ref:`Viewport<class_Viewport>` using the VisualServer API:
|
|||
|
|
|
|||
|
|
::
|
|||
|
|
|
|||
|
|
func _ready():
|
|||
|
|
var viewport_rid = get_viewport().get_viewport_rid()
|
|||
|
|
var viewport_texture_rid = VisualServer.viewport_get_texture(viewport_rid)
|
|||
|
|
|
|||
|
|
var proxy_texture = ImageTexture.new()
|
|||
|
|
var viewport_texture_image_data = VisualServer.texture_get_data(viewport_texture_rid)
|
|||
|
|
|
|||
|
|
proxy_texture.create_from_image(viewport_texture_image_data)
|
|||
|
|
var proxy_texture_rid = proxy_texture.get_rid()
|
|||
|
|
VisualServer.texture_set_proxy(proxy_texture_rid, viewport_texture_rid)
|
|||
|
|
|
|||
|
|
$TextureRect.texture = proxy_texture
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_texture_set_shrink_all_x2_on_set_data:
|
|||
|
|
|
|||
|
|
- void **texture_set_shrink_all_x2_on_set_data** **(** :ref:`bool<class_bool>` shrink **)**
|
|||
|
|
|
|||
|
|
If ``true``, sets internal processes to shrink all image data to half the size.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_texture_set_size_override:
|
|||
|
|
|
|||
|
|
- void **texture_set_size_override** **(** :ref:`RID<class_RID>` texture, :ref:`int<class_int>` width, :ref:`int<class_int>` height, :ref:`int<class_int>` depth **)**
|
|||
|
|
|
|||
|
|
Resizes the texture to the specified dimensions.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_textures_keep_original:
|
|||
|
|
|
|||
|
|
- void **textures_keep_original** **(** :ref:`bool<class_bool>` enable **)**
|
|||
|
|
|
|||
|
|
If ``true``, the image will be stored in the texture's images array if overwritten.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_viewport_attach_camera:
|
|||
|
|
|
|||
|
|
- void **viewport_attach_camera** **(** :ref:`RID<class_RID>` viewport, :ref:`RID<class_RID>` camera **)**
|
|||
|
|
|
|||
|
|
Sets a viewport's camera.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_viewport_attach_canvas:
|
|||
|
|
|
|||
|
|
- void **viewport_attach_canvas** **(** :ref:`RID<class_RID>` viewport, :ref:`RID<class_RID>` canvas **)**
|
|||
|
|
|
|||
|
|
Sets a viewport's canvas.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_viewport_attach_to_screen:
|
|||
|
|
|
|||
|
|
- void **viewport_attach_to_screen** **(** :ref:`RID<class_RID>` viewport, :ref:`Rect2<class_Rect2>` rect=Rect2( 0, 0, 0, 0 ), :ref:`int<class_int>` screen=0 **)**
|
|||
|
|
|
|||
|
|
Copies viewport to a region of the screen specified by ``rect``. If :ref:`Viewport.render_direct_to_screen<class_Viewport_property_render_direct_to_screen>` is ``true``, then 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:
|
|||
|
|
|
|||
|
|
::
|
|||
|
|
|
|||
|
|
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<class_VisualServer_method_viewport_set_render_direct_to_screen>`.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_viewport_create:
|
|||
|
|
|
|||
|
|
- :ref:`RID<class_RID>` **viewport_create** **(** **)**
|
|||
|
|
|
|||
|
|
Creates an empty viewport and adds it to the VisualServer. It can be accessed with the RID that is returned. This RID will be used in all ``viewport_*`` VisualServer functions.
|
|||
|
|
|
|||
|
|
Once finished with your RID, you will want to free the RID using the VisualServer's :ref:`free_rid<class_VisualServer_method_free_rid>` static method.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_viewport_detach:
|
|||
|
|
|
|||
|
|
- void **viewport_detach** **(** :ref:`RID<class_RID>` viewport **)**
|
|||
|
|
|
|||
|
|
Detaches the viewport from the screen.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_viewport_get_render_info:
|
|||
|
|
|
|||
|
|
- :ref:`int<class_int>` **viewport_get_render_info** **(** :ref:`RID<class_RID>` viewport, :ref:`ViewportRenderInfo<enum_VisualServer_ViewportRenderInfo>` info **)**
|
|||
|
|
|
|||
|
|
Returns a viewport's render information. For options, see the :ref:`ViewportRenderInfo<enum_VisualServer_ViewportRenderInfo>` constants.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_viewport_get_texture:
|
|||
|
|
|
|||
|
|
- :ref:`RID<class_RID>` **viewport_get_texture** **(** :ref:`RID<class_RID>` viewport **)** |const|
|
|||
|
|
|
|||
|
|
Returns the viewport's last rendered frame.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_viewport_remove_canvas:
|
|||
|
|
|
|||
|
|
- void **viewport_remove_canvas** **(** :ref:`RID<class_RID>` viewport, :ref:`RID<class_RID>` canvas **)**
|
|||
|
|
|
|||
|
|
Detaches a viewport from a canvas and vice versa.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_viewport_set_active:
|
|||
|
|
|
|||
|
|
- void **viewport_set_active** **(** :ref:`RID<class_RID>` viewport, :ref:`bool<class_bool>` active **)**
|
|||
|
|
|
|||
|
|
If ``true``, sets the viewport active, else sets it inactive.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_viewport_set_canvas_stacking:
|
|||
|
|
|
|||
|
|
- void **viewport_set_canvas_stacking** **(** :ref:`RID<class_RID>` viewport, :ref:`RID<class_RID>` canvas, :ref:`int<class_int>` layer, :ref:`int<class_int>` sublayer **)**
|
|||
|
|
|
|||
|
|
Sets the stacking order for a viewport's canvas.
|
|||
|
|
|
|||
|
|
\ ``layer`` is the actual canvas layer, while ``sublayer`` specifies the stacking order of the canvas among those in the same layer.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_viewport_set_canvas_transform:
|
|||
|
|
|
|||
|
|
- void **viewport_set_canvas_transform** **(** :ref:`RID<class_RID>` viewport, :ref:`RID<class_RID>` canvas, :ref:`Transform2D<class_Transform2D>` offset **)**
|
|||
|
|
|
|||
|
|
Sets the transformation of a viewport's canvas.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_viewport_set_clear_mode:
|
|||
|
|
|
|||
|
|
- void **viewport_set_clear_mode** **(** :ref:`RID<class_RID>` viewport, :ref:`ViewportClearMode<enum_VisualServer_ViewportClearMode>` clear_mode **)**
|
|||
|
|
|
|||
|
|
Sets the clear mode of a viewport. See :ref:`ViewportClearMode<enum_VisualServer_ViewportClearMode>` for options.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_viewport_set_debug_draw:
|
|||
|
|
|
|||
|
|
- void **viewport_set_debug_draw** **(** :ref:`RID<class_RID>` viewport, :ref:`ViewportDebugDraw<enum_VisualServer_ViewportDebugDraw>` draw **)**
|
|||
|
|
|
|||
|
|
Sets the debug draw mode of a viewport. See :ref:`ViewportDebugDraw<enum_VisualServer_ViewportDebugDraw>` for options.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_viewport_set_disable_3d:
|
|||
|
|
|
|||
|
|
- void **viewport_set_disable_3d** **(** :ref:`RID<class_RID>` viewport, :ref:`bool<class_bool>` disabled **)**
|
|||
|
|
|
|||
|
|
If ``true``, a viewport's 3D rendering is disabled.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_viewport_set_disable_environment:
|
|||
|
|
|
|||
|
|
- void **viewport_set_disable_environment** **(** :ref:`RID<class_RID>` viewport, :ref:`bool<class_bool>` disabled **)**
|
|||
|
|
|
|||
|
|
If ``true``, rendering of a viewport's environment is disabled.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_viewport_set_global_canvas_transform:
|
|||
|
|
|
|||
|
|
- void **viewport_set_global_canvas_transform** **(** :ref:`RID<class_RID>` viewport, :ref:`Transform2D<class_Transform2D>` transform **)**
|
|||
|
|
|
|||
|
|
Sets the viewport's global transformation matrix.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_viewport_set_hdr:
|
|||
|
|
|
|||
|
|
- void **viewport_set_hdr** **(** :ref:`RID<class_RID>` viewport, :ref:`bool<class_bool>` enabled **)**
|
|||
|
|
|
|||
|
|
If ``true``, the viewport renders to high dynamic range (HDR) instead of standard dynamic range (SDR). See also :ref:`viewport_set_use_32_bpc_depth<class_VisualServer_method_viewport_set_use_32_bpc_depth>`.
|
|||
|
|
|
|||
|
|
\ **Note:** Only available on the GLES3 backend.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_viewport_set_hide_canvas:
|
|||
|
|
|
|||
|
|
- void **viewport_set_hide_canvas** **(** :ref:`RID<class_RID>` viewport, :ref:`bool<class_bool>` hidden **)**
|
|||
|
|
|
|||
|
|
If ``true``, the viewport's canvas is not rendered.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_viewport_set_hide_scenario:
|
|||
|
|
|
|||
|
|
- void **viewport_set_hide_scenario** **(** :ref:`RID<class_RID>` viewport, :ref:`bool<class_bool>` hidden **)**
|
|||
|
|
|
|||
|
|
Currently unimplemented in Godot 3.x.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_viewport_set_msaa:
|
|||
|
|
|
|||
|
|
- void **viewport_set_msaa** **(** :ref:`RID<class_RID>` viewport, :ref:`ViewportMSAA<enum_VisualServer_ViewportMSAA>` msaa **)**
|
|||
|
|
|
|||
|
|
Sets the anti-aliasing mode. See :ref:`ViewportMSAA<enum_VisualServer_ViewportMSAA>` for options.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_viewport_set_parent_viewport:
|
|||
|
|
|
|||
|
|
- void **viewport_set_parent_viewport** **(** :ref:`RID<class_RID>` viewport, :ref:`RID<class_RID>` parent_viewport **)**
|
|||
|
|
|
|||
|
|
Sets the viewport's parent to another viewport.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_viewport_set_render_direct_to_screen:
|
|||
|
|
|
|||
|
|
- void **viewport_set_render_direct_to_screen** **(** :ref:`RID<class_RID>` viewport, :ref:`bool<class_bool>` enabled **)**
|
|||
|
|
|
|||
|
|
If ``true``, render the contents of the viewport directly to screen. This allows a low-level optimization where you can skip drawing a viewport to the root viewport. While this optimization can result in a significant increase in speed (especially on older devices), it comes at a cost of usability. When this is enabled, you cannot read from the viewport or from the ``SCREEN_TEXTURE``. You also lose the benefit of certain window settings, such as the various stretch modes. Another consequence to be aware of is that in 2D the rendering happens in window coordinates, so if you have a viewport that is double the size of the window, and you set this, then only the portion that fits within the window will be drawn, no automatic scaling is possible, even if your game scene is significantly larger than the window size.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_viewport_set_scenario:
|
|||
|
|
|
|||
|
|
- void **viewport_set_scenario** **(** :ref:`RID<class_RID>` viewport, :ref:`RID<class_RID>` scenario **)**
|
|||
|
|
|
|||
|
|
Sets a viewport's scenario.
|
|||
|
|
|
|||
|
|
The scenario contains information about the :ref:`ScenarioDebugMode<enum_VisualServer_ScenarioDebugMode>`, environment information, reflection atlas etc.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_viewport_set_shadow_atlas_quadrant_subdivision:
|
|||
|
|
|
|||
|
|
- void **viewport_set_shadow_atlas_quadrant_subdivision** **(** :ref:`RID<class_RID>` viewport, :ref:`int<class_int>` quadrant, :ref:`int<class_int>` subdivision **)**
|
|||
|
|
|
|||
|
|
Sets the shadow atlas quadrant's subdivision.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_viewport_set_shadow_atlas_size:
|
|||
|
|
|
|||
|
|
- void **viewport_set_shadow_atlas_size** **(** :ref:`RID<class_RID>` viewport, :ref:`int<class_int>` size **)**
|
|||
|
|
|
|||
|
|
Sets the size of the shadow atlas's images (used for omni and spot lights). The value will be rounded up to the nearest power of 2.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_viewport_set_sharpen_intensity:
|
|||
|
|
|
|||
|
|
- void **viewport_set_sharpen_intensity** **(** :ref:`RID<class_RID>` viewport, :ref:`float<class_float>` intensity **)**
|
|||
|
|
|
|||
|
|
Sets the sharpening ``intensity`` for the ``viewport``. If set to a value greater than ``0.0``, contrast-adaptive sharpening will be applied to the 3D viewport. This has a low performance cost and can be used to recover some of the sharpness lost from using FXAA. Values around ``0.5`` generally give the best results. See also :ref:`viewport_set_use_fxaa<class_VisualServer_method_viewport_set_use_fxaa>`.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_viewport_set_size:
|
|||
|
|
|
|||
|
|
- void **viewport_set_size** **(** :ref:`RID<class_RID>` viewport, :ref:`int<class_int>` width, :ref:`int<class_int>` height **)**
|
|||
|
|
|
|||
|
|
Sets the viewport's width and height.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_viewport_set_transparent_background:
|
|||
|
|
|
|||
|
|
- void **viewport_set_transparent_background** **(** :ref:`RID<class_RID>` viewport, :ref:`bool<class_bool>` enabled **)**
|
|||
|
|
|
|||
|
|
If ``true``, the viewport renders its background as transparent.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_viewport_set_update_mode:
|
|||
|
|
|
|||
|
|
- void **viewport_set_update_mode** **(** :ref:`RID<class_RID>` viewport, :ref:`ViewportUpdateMode<enum_VisualServer_ViewportUpdateMode>` update_mode **)**
|
|||
|
|
|
|||
|
|
Sets when the viewport should be updated. See :ref:`ViewportUpdateMode<enum_VisualServer_ViewportUpdateMode>` constants for options.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_viewport_set_usage:
|
|||
|
|
|
|||
|
|
- void **viewport_set_usage** **(** :ref:`RID<class_RID>` viewport, :ref:`ViewportUsage<enum_VisualServer_ViewportUsage>` usage **)**
|
|||
|
|
|
|||
|
|
Sets the viewport's 2D/3D mode. See :ref:`ViewportUsage<enum_VisualServer_ViewportUsage>` constants for options.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_viewport_set_use_32_bpc_depth:
|
|||
|
|
|
|||
|
|
- void **viewport_set_use_32_bpc_depth** **(** :ref:`RID<class_RID>` viewport, :ref:`bool<class_bool>` enabled **)**
|
|||
|
|
|
|||
|
|
If ``true``, allocates the viewport's framebuffer with full floating-point precision (32-bit) instead of half floating-point precision (16-bit). Only effective if :ref:`viewport_set_use_32_bpc_depth<class_VisualServer_method_viewport_set_use_32_bpc_depth>` is used on the same :ref:`Viewport<class_Viewport>` to set HDR to ``true``.
|
|||
|
|
|
|||
|
|
\ **Note:** Only available on the GLES3 backend.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_viewport_set_use_arvr:
|
|||
|
|
|
|||
|
|
- void **viewport_set_use_arvr** **(** :ref:`RID<class_RID>` viewport, :ref:`bool<class_bool>` use_arvr **)**
|
|||
|
|
|
|||
|
|
If ``true``, the viewport uses augmented or virtual reality technologies. See :ref:`ARVRInterface<class_ARVRInterface>`.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_viewport_set_use_debanding:
|
|||
|
|
|
|||
|
|
- void **viewport_set_use_debanding** **(** :ref:`RID<class_RID>` viewport, :ref:`bool<class_bool>` debanding **)**
|
|||
|
|
|
|||
|
|
If ``true``, uses a fast post-processing filter to make banding significantly less visible. In some cases, debanding may introduce a slightly noticeable dithering pattern. It's recommended to enable debanding only when actually needed since the dithering pattern will make lossless-compressed screenshots larger.
|
|||
|
|
|
|||
|
|
\ **Note:** Only available on the GLES3 backend. :ref:`Viewport.hdr<class_Viewport_property_hdr>` must also be ``true`` for debanding to be effective.
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_viewport_set_use_fxaa:
|
|||
|
|
|
|||
|
|
- void **viewport_set_use_fxaa** **(** :ref:`RID<class_RID>` viewport, :ref:`bool<class_bool>` fxaa **)**
|
|||
|
|
|
|||
|
|
Enables fast approximate antialiasing for this viewport. FXAA is a popular screen-space antialiasing method, which is fast but will make the image look blurry, especially at lower resolutions. It can still work relatively well at large resolutions such as 1440p and 4K. Some of the lost sharpness can be recovered by enabling contrast-adaptive sharpening (see :ref:`viewport_set_sharpen_intensity<class_VisualServer_method_viewport_set_sharpen_intensity>`).
|
|||
|
|
|
|||
|
|
----
|
|||
|
|
|
|||
|
|
.. _class_VisualServer_method_viewport_set_vflip:
|
|||
|
|
|
|||
|
|
- void **viewport_set_vflip** **(** :ref:`RID<class_RID>` viewport, :ref:`bool<class_bool>` enabled **)**
|
|||
|
|
|
|||
|
|
If ``true``, the viewport's rendering is flipped vertically.
|
|||
|
|
|
|||
|
|
.. |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.)`
|