summaryrefslogtreecommitdiff
path: root/doc/classes/RenderingServer.xml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/classes/RenderingServer.xml')
-rw-r--r--doc/classes/RenderingServer.xml2244
1 files changed, 1161 insertions, 1083 deletions
diff --git a/doc/classes/RenderingServer.xml b/doc/classes/RenderingServer.xml
index c2752d9f7b..6aa9237385 100644
--- a/doc/classes/RenderingServer.xml
+++ b/doc/classes/RenderingServer.xml
@@ -20,124 +20,148 @@
<methods>
<method name="bake_render_uv2">
<return type="Image[]" />
- <argument index="0" name="base" type="RID" />
- <argument index="1" name="material_overrides" type="Array" />
- <argument index="2" name="image_size" type="Vector2i" />
+ <param index="0" name="base" type="RID" />
+ <param index="1" name="material_overrides" type="RID[]" />
+ <param index="2" name="image_size" type="Vector2i" />
<description>
</description>
</method>
- <method name="camera_create">
+ <method name="camera_attributes_create">
<return type="RID" />
<description>
- Creates a camera and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all [code]camera_*[/code] RenderingServer functions.
+ Creates a camera attributes object and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all [code]camera_attributes_[/code] RenderingServer functions.
Once finished with your RID, you will want to free the RID using the RenderingServer's [method free_rid] static method.
</description>
</method>
- <method name="camera_effects_create">
- <return type="RID" />
+ <method name="camera_attributes_set_auto_exposure">
+ <return type="void" />
+ <param index="0" name="camera_attributes" type="RID" />
+ <param index="1" name="enable" type="bool" />
+ <param index="2" name="min_sensitivity" type="float" />
+ <param index="3" name="max_sensitivity" type="float" />
+ <param index="4" name="speed" type="float" />
+ <param index="5" name="scale" type="float" />
<description>
</description>
</method>
- <method name="camera_effects_set_custom_exposure">
+ <method name="camera_attributes_set_dof_blur">
<return type="void" />
- <argument index="0" name="camera_effects" type="RID" />
- <argument index="1" name="enable" type="bool" />
- <argument index="2" name="exposure" type="float" />
+ <param index="0" name="camera_attributes" type="RID" />
+ <param index="1" name="far_enable" type="bool" />
+ <param index="2" name="far_distance" type="float" />
+ <param index="3" name="far_transition" type="float" />
+ <param index="4" name="near_enable" type="bool" />
+ <param index="5" name="near_distance" type="float" />
+ <param index="6" name="near_transition" type="float" />
+ <param index="7" name="amount" type="float" />
<description>
</description>
</method>
- <method name="camera_effects_set_dof_blur">
+ <method name="camera_attributes_set_dof_blur_bokeh_shape">
<return type="void" />
- <argument index="0" name="camera_effects" type="RID" />
- <argument index="1" name="far_enable" type="bool" />
- <argument index="2" name="far_distance" type="float" />
- <argument index="3" name="far_transition" type="float" />
- <argument index="4" name="near_enable" type="bool" />
- <argument index="5" name="near_distance" type="float" />
- <argument index="6" name="near_transition" type="float" />
- <argument index="7" name="amount" type="float" />
+ <param index="0" name="shape" type="int" enum="RenderingServer.DOFBokehShape" />
<description>
</description>
</method>
- <method name="camera_effects_set_dof_blur_bokeh_shape">
+ <method name="camera_attributes_set_dof_blur_quality">
<return type="void" />
- <argument index="0" name="shape" type="int" enum="RenderingServer.DOFBokehShape" />
+ <param index="0" name="quality" type="int" enum="RenderingServer.DOFBlurQuality" />
+ <param index="1" name="use_jitter" type="bool" />
<description>
</description>
</method>
- <method name="camera_effects_set_dof_blur_quality">
+ <method name="camera_attributes_set_exposure">
<return type="void" />
- <argument index="0" name="quality" type="int" enum="RenderingServer.DOFBlurQuality" />
- <argument index="1" name="use_jitter" type="bool" />
+ <param index="0" name="camera_attributes" type="RID" />
+ <param index="1" name="multiplier" type="float" />
+ <param index="2" name="normalization" type="float" />
+ <description>
+ Sets the exposure values that will be used by the renderers. The normalization amount is used to bake a given Exposure Value (EV) into rendering calculations to reduce the dynamic range of the scene.
+ The normalization factor can be calculated from exposure value (EV100) as follows:
+ [codeblock]
+ func get_exposure_normalization(float ev100):
+ return 1.0 / (pow(2.0, ev100) * 1.2)
+ [/codeblock]
+ The exposure value can be calculated from aperture (in f-stops), shutter speed (in seconds), and sensitivity (in ISO) as follows:
+ [codeblock]
+ func get_exposure(float aperture, float shutter_speed, float sensitivity):
+ return log2((aperture * aperture) / shutterSpeed * (100.0 / sensitivity))
+ [/codeblock]
+ </description>
+ </method>
+ <method name="camera_create">
+ <return type="RID" />
<description>
+ Creates a camera and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all [code]camera_*[/code] RenderingServer functions.
+ Once finished with your RID, you will want to free the RID using the RenderingServer's [method free_rid] static method.
</description>
</method>
- <method name="camera_set_camera_effects">
+ <method name="camera_set_camera_attributes">
<return type="void" />
- <argument index="0" name="camera" type="RID" />
- <argument index="1" name="effects" type="RID" />
+ <param index="0" name="camera" type="RID" />
+ <param index="1" name="effects" type="RID" />
<description>
</description>
</method>
<method name="camera_set_cull_mask">
<return type="void" />
- <argument index="0" name="camera" type="RID" />
- <argument index="1" name="layers" type="int" />
+ <param index="0" name="camera" type="RID" />
+ <param index="1" name="layers" type="int" />
<description>
Sets the cull mask associated with this camera. The cull mask describes which 3D layers are rendered by this camera. Equivalent to [member Camera3D.cull_mask].
</description>
</method>
<method name="camera_set_environment">
<return type="void" />
- <argument index="0" name="camera" type="RID" />
- <argument index="1" name="env" type="RID" />
+ <param index="0" name="camera" type="RID" />
+ <param index="1" name="env" type="RID" />
<description>
Sets the environment used by this camera. Equivalent to [member Camera3D.environment].
</description>
</method>
<method name="camera_set_frustum">
<return type="void" />
- <argument index="0" name="camera" type="RID" />
- <argument index="1" name="size" type="float" />
- <argument index="2" name="offset" type="Vector2" />
- <argument index="3" name="z_near" type="float" />
- <argument index="4" name="z_far" type="float" />
+ <param index="0" name="camera" type="RID" />
+ <param index="1" name="size" type="float" />
+ <param index="2" name="offset" type="Vector2" />
+ <param index="3" name="z_near" type="float" />
+ <param index="4" name="z_far" type="float" />
<description>
- Sets camera to use frustum projection. This mode allows adjusting the [code]offset[/code] argument to create "tilted frustum" effects.
+ Sets camera to use frustum projection. This mode allows adjusting the [param offset] argument to create "tilted frustum" effects.
</description>
</method>
<method name="camera_set_orthogonal">
<return type="void" />
- <argument index="0" name="camera" type="RID" />
- <argument index="1" name="size" type="float" />
- <argument index="2" name="z_near" type="float" />
- <argument index="3" name="z_far" type="float" />
+ <param index="0" name="camera" type="RID" />
+ <param index="1" name="size" type="float" />
+ <param index="2" name="z_near" type="float" />
+ <param index="3" name="z_far" type="float" />
<description>
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.
</description>
</method>
<method name="camera_set_perspective">
<return type="void" />
- <argument index="0" name="camera" type="RID" />
- <argument index="1" name="fovy_degrees" type="float" />
- <argument index="2" name="z_near" type="float" />
- <argument index="3" name="z_far" type="float" />
+ <param index="0" name="camera" type="RID" />
+ <param index="1" name="fovy_degrees" type="float" />
+ <param index="2" name="z_near" type="float" />
+ <param index="3" name="z_far" type="float" />
<description>
Sets camera to use perspective projection. Objects on the screen becomes smaller when they are far away.
</description>
</method>
<method name="camera_set_transform">
<return type="void" />
- <argument index="0" name="camera" type="RID" />
- <argument index="1" name="transform" type="Transform3D" />
+ <param index="0" name="camera" type="RID" />
+ <param index="1" name="transform" type="Transform3D" />
<description>
Sets [Transform3D] of camera.
</description>
</method>
<method name="camera_set_use_vertical_aspect">
<return type="void" />
- <argument index="0" name="camera" type="RID" />
- <argument index="1" name="enable" type="bool" />
+ <param index="0" name="camera" type="RID" />
+ <param index="1" name="enable" type="bool" />
<description>
If [code]true[/code], preserves the horizontal aspect ratio which is equivalent to [constant Camera3D.KEEP_WIDTH]. If [code]false[/code], preserves the vertical aspect ratio which is equivalent to [constant Camera3D.KEEP_HEIGHT].
</description>
@@ -151,181 +175,191 @@
</method>
<method name="canvas_item_add_animation_slice">
<return type="void" />
- <argument index="0" name="item" type="RID" />
- <argument index="1" name="animation_length" type="float" />
- <argument index="2" name="slice_begin" type="float" />
- <argument index="3" name="slice_end" type="float" />
- <argument index="4" name="offset" type="float" default="0.0" />
+ <param index="0" name="item" type="RID" />
+ <param index="1" name="animation_length" type="float" />
+ <param index="2" name="slice_begin" type="float" />
+ <param index="3" name="slice_end" type="float" />
+ <param index="4" name="offset" type="float" default="0.0" />
<description>
Subsequent drawing commands will be ignored unless they fall within the specified animation slice. This is a faster way to implement animations that loop on background rather than redrawing constantly.
</description>
</method>
<method name="canvas_item_add_circle">
<return type="void" />
- <argument index="0" name="item" type="RID" />
- <argument index="1" name="pos" type="Vector2" />
- <argument index="2" name="radius" type="float" />
- <argument index="3" name="color" type="Color" />
+ <param index="0" name="item" type="RID" />
+ <param index="1" name="pos" type="Vector2" />
+ <param index="2" name="radius" type="float" />
+ <param index="3" name="color" type="Color" />
<description>
</description>
</method>
<method name="canvas_item_add_clip_ignore">
<return type="void" />
- <argument index="0" name="item" type="RID" />
- <argument index="1" name="ignore" type="bool" />
+ <param index="0" name="item" type="RID" />
+ <param index="1" name="ignore" type="bool" />
+ <description>
+ </description>
+ </method>
+ <method name="canvas_item_add_lcd_texture_rect_region">
+ <return type="void" />
+ <param index="0" name="item" type="RID" />
+ <param index="1" name="rect" type="Rect2" />
+ <param index="2" name="texture" type="RID" />
+ <param index="3" name="src_rect" type="Rect2" />
+ <param index="4" name="modulate" type="Color" />
<description>
</description>
</method>
<method name="canvas_item_add_line">
<return type="void" />
- <argument index="0" name="item" type="RID" />
- <argument index="1" name="from" type="Vector2" />
- <argument index="2" name="to" type="Vector2" />
- <argument index="3" name="color" type="Color" />
- <argument index="4" name="width" type="float" default="1.0" />
- <argument index="5" name="antialiased" type="bool" default="false" />
+ <param index="0" name="item" type="RID" />
+ <param index="1" name="from" type="Vector2" />
+ <param index="2" name="to" type="Vector2" />
+ <param index="3" name="color" type="Color" />
+ <param index="4" name="width" type="float" default="1.0" />
+ <param index="5" name="antialiased" type="bool" default="false" />
<description>
</description>
</method>
<method name="canvas_item_add_mesh">
<return type="void" />
- <argument index="0" name="item" type="RID" />
- <argument index="1" name="mesh" type="RID" />
- <argument index="2" name="transform" type="Transform2D" default="Transform2D(1, 0, 0, 1, 0, 0)" />
- <argument index="3" name="modulate" type="Color" default="Color(1, 1, 1, 1)" />
- <argument index="4" name="texture" type="RID" />
+ <param index="0" name="item" type="RID" />
+ <param index="1" name="mesh" type="RID" />
+ <param index="2" name="transform" type="Transform2D" default="Transform2D(1, 0, 0, 1, 0, 0)" />
+ <param index="3" name="modulate" type="Color" default="Color(1, 1, 1, 1)" />
+ <param index="4" name="texture" type="RID" />
<description>
</description>
</method>
<method name="canvas_item_add_msdf_texture_rect_region">
<return type="void" />
- <argument index="0" name="item" type="RID" />
- <argument index="1" name="rect" type="Rect2" />
- <argument index="2" name="texture" type="RID" />
- <argument index="3" name="src_rect" type="Rect2" />
- <argument index="4" name="modulate" type="Color" default="Color(1, 1, 1, 1)" />
- <argument index="5" name="outline_size" type="int" default="0" />
- <argument index="6" name="px_range" type="float" default="1.0" />
+ <param index="0" name="item" type="RID" />
+ <param index="1" name="rect" type="Rect2" />
+ <param index="2" name="texture" type="RID" />
+ <param index="3" name="src_rect" type="Rect2" />
+ <param index="4" name="modulate" type="Color" default="Color(1, 1, 1, 1)" />
+ <param index="5" name="outline_size" type="int" default="0" />
+ <param index="6" name="px_range" type="float" default="1.0" />
<description>
</description>
</method>
<method name="canvas_item_add_multimesh">
<return type="void" />
- <argument index="0" name="item" type="RID" />
- <argument index="1" name="mesh" type="RID" />
- <argument index="2" name="texture" type="RID" />
+ <param index="0" name="item" type="RID" />
+ <param index="1" name="mesh" type="RID" />
+ <param index="2" name="texture" type="RID" />
<description>
</description>
</method>
<method name="canvas_item_add_nine_patch">
<return type="void" />
- <argument index="0" name="item" type="RID" />
- <argument index="1" name="rect" type="Rect2" />
- <argument index="2" name="source" type="Rect2" />
- <argument index="3" name="texture" type="RID" />
- <argument index="4" name="topleft" type="Vector2" />
- <argument index="5" name="bottomright" type="Vector2" />
- <argument index="6" name="x_axis_mode" type="int" enum="RenderingServer.NinePatchAxisMode" default="0" />
- <argument index="7" name="y_axis_mode" type="int" enum="RenderingServer.NinePatchAxisMode" default="0" />
- <argument index="8" name="draw_center" type="bool" default="true" />
- <argument index="9" name="modulate" type="Color" default="Color(1, 1, 1, 1)" />
+ <param index="0" name="item" type="RID" />
+ <param index="1" name="rect" type="Rect2" />
+ <param index="2" name="source" type="Rect2" />
+ <param index="3" name="texture" type="RID" />
+ <param index="4" name="topleft" type="Vector2" />
+ <param index="5" name="bottomright" type="Vector2" />
+ <param index="6" name="x_axis_mode" type="int" enum="RenderingServer.NinePatchAxisMode" default="0" />
+ <param index="7" name="y_axis_mode" type="int" enum="RenderingServer.NinePatchAxisMode" default="0" />
+ <param index="8" name="draw_center" type="bool" default="true" />
+ <param index="9" name="modulate" type="Color" default="Color(1, 1, 1, 1)" />
<description>
</description>
</method>
<method name="canvas_item_add_particles">
<return type="void" />
- <argument index="0" name="item" type="RID" />
- <argument index="1" name="particles" type="RID" />
- <argument index="2" name="texture" type="RID" />
+ <param index="0" name="item" type="RID" />
+ <param index="1" name="particles" type="RID" />
+ <param index="2" name="texture" type="RID" />
<description>
</description>
</method>
<method name="canvas_item_add_polygon">
<return type="void" />
- <argument index="0" name="item" type="RID" />
- <argument index="1" name="points" type="PackedVector2Array" />
- <argument index="2" name="colors" type="PackedColorArray" />
- <argument index="3" name="uvs" type="PackedVector2Array" default="PackedVector2Array()" />
- <argument index="4" name="texture" type="RID" />
+ <param index="0" name="item" type="RID" />
+ <param index="1" name="points" type="PackedVector2Array" />
+ <param index="2" name="colors" type="PackedColorArray" />
+ <param index="3" name="uvs" type="PackedVector2Array" default="PackedVector2Array()" />
+ <param index="4" name="texture" type="RID" />
<description>
</description>
</method>
<method name="canvas_item_add_polyline">
<return type="void" />
- <argument index="0" name="item" type="RID" />
- <argument index="1" name="points" type="PackedVector2Array" />
- <argument index="2" name="colors" type="PackedColorArray" />
- <argument index="3" name="width" type="float" default="1.0" />
- <argument index="4" name="antialiased" type="bool" default="false" />
+ <param index="0" name="item" type="RID" />
+ <param index="1" name="points" type="PackedVector2Array" />
+ <param index="2" name="colors" type="PackedColorArray" />
+ <param index="3" name="width" type="float" default="1.0" />
+ <param index="4" name="antialiased" type="bool" default="false" />
<description>
</description>
</method>
<method name="canvas_item_add_primitive">
<return type="void" />
- <argument index="0" name="item" type="RID" />
- <argument index="1" name="points" type="PackedVector2Array" />
- <argument index="2" name="colors" type="PackedColorArray" />
- <argument index="3" name="uvs" type="PackedVector2Array" />
- <argument index="4" name="texture" type="RID" />
- <argument index="5" name="width" type="float" default="1.0" />
+ <param index="0" name="item" type="RID" />
+ <param index="1" name="points" type="PackedVector2Array" />
+ <param index="2" name="colors" type="PackedColorArray" />
+ <param index="3" name="uvs" type="PackedVector2Array" />
+ <param index="4" name="texture" type="RID" />
+ <param index="5" name="width" type="float" default="1.0" />
<description>
</description>
</method>
<method name="canvas_item_add_rect">
<return type="void" />
- <argument index="0" name="item" type="RID" />
- <argument index="1" name="rect" type="Rect2" />
- <argument index="2" name="color" type="Color" />
+ <param index="0" name="item" type="RID" />
+ <param index="1" name="rect" type="Rect2" />
+ <param index="2" name="color" type="Color" />
<description>
</description>
</method>
<method name="canvas_item_add_set_transform">
<return type="void" />
- <argument index="0" name="item" type="RID" />
- <argument index="1" name="transform" type="Transform2D" />
+ <param index="0" name="item" type="RID" />
+ <param index="1" name="transform" type="Transform2D" />
<description>
</description>
</method>
<method name="canvas_item_add_texture_rect">
<return type="void" />
- <argument index="0" name="item" type="RID" />
- <argument index="1" name="rect" type="Rect2" />
- <argument index="2" name="texture" type="RID" />
- <argument index="3" name="tile" type="bool" default="false" />
- <argument index="4" name="modulate" type="Color" default="Color(1, 1, 1, 1)" />
- <argument index="5" name="transpose" type="bool" default="false" />
+ <param index="0" name="item" type="RID" />
+ <param index="1" name="rect" type="Rect2" />
+ <param index="2" name="texture" type="RID" />
+ <param index="3" name="tile" type="bool" default="false" />
+ <param index="4" name="modulate" type="Color" default="Color(1, 1, 1, 1)" />
+ <param index="5" name="transpose" type="bool" default="false" />
<description>
</description>
</method>
<method name="canvas_item_add_texture_rect_region">
<return type="void" />
- <argument index="0" name="item" type="RID" />
- <argument index="1" name="rect" type="Rect2" />
- <argument index="2" name="texture" type="RID" />
- <argument index="3" name="src_rect" type="Rect2" />
- <argument index="4" name="modulate" type="Color" default="Color(1, 1, 1, 1)" />
- <argument index="5" name="transpose" type="bool" default="false" />
- <argument index="6" name="clip_uv" type="bool" default="true" />
+ <param index="0" name="item" type="RID" />
+ <param index="1" name="rect" type="Rect2" />
+ <param index="2" name="texture" type="RID" />
+ <param index="3" name="src_rect" type="Rect2" />
+ <param index="4" name="modulate" type="Color" default="Color(1, 1, 1, 1)" />
+ <param index="5" name="transpose" type="bool" default="false" />
+ <param index="6" name="clip_uv" type="bool" default="true" />
<description>
</description>
</method>
<method name="canvas_item_add_triangle_array">
<return type="void" />
- <argument index="0" name="item" type="RID" />
- <argument index="1" name="indices" type="PackedInt32Array" />
- <argument index="2" name="points" type="PackedVector2Array" />
- <argument index="3" name="colors" type="PackedColorArray" />
- <argument index="4" name="uvs" type="PackedVector2Array" default="PackedVector2Array()" />
- <argument index="5" name="bones" type="PackedInt32Array" default="PackedInt32Array()" />
- <argument index="6" name="weights" type="PackedFloat32Array" default="PackedFloat32Array()" />
- <argument index="7" name="texture" type="RID" />
- <argument index="8" name="count" type="int" default="-1" />
+ <param index="0" name="item" type="RID" />
+ <param index="1" name="indices" type="PackedInt32Array" />
+ <param index="2" name="points" type="PackedVector2Array" />
+ <param index="3" name="colors" type="PackedColorArray" />
+ <param index="4" name="uvs" type="PackedVector2Array" default="PackedVector2Array()" />
+ <param index="5" name="bones" type="PackedInt32Array" default="PackedInt32Array()" />
+ <param index="6" name="weights" type="PackedFloat32Array" default="PackedFloat32Array()" />
+ <param index="7" name="texture" type="RID" />
+ <param index="8" name="count" type="int" default="-1" />
<description>
</description>
</method>
<method name="canvas_item_clear">
<return type="void" />
- <argument index="0" name="item" type="RID" />
+ <param index="0" name="item" type="RID" />
<description>
Clears the [CanvasItem] and removes all commands in it.
</description>
@@ -337,170 +371,170 @@
</method>
<method name="canvas_item_set_canvas_group_mode">
<return type="void" />
- <argument index="0" name="item" type="RID" />
- <argument index="1" name="mode" type="int" enum="RenderingServer.CanvasGroupMode" />
- <argument index="2" name="clear_margin" type="float" default="5.0" />
- <argument index="3" name="fit_empty" type="bool" default="false" />
- <argument index="4" name="fit_margin" type="float" default="0.0" />
- <argument index="5" name="blur_mipmaps" type="bool" default="false" />
+ <param index="0" name="item" type="RID" />
+ <param index="1" name="mode" type="int" enum="RenderingServer.CanvasGroupMode" />
+ <param index="2" name="clear_margin" type="float" default="5.0" />
+ <param index="3" name="fit_empty" type="bool" default="false" />
+ <param index="4" name="fit_margin" type="float" default="0.0" />
+ <param index="5" name="blur_mipmaps" type="bool" default="false" />
<description>
</description>
</method>
<method name="canvas_item_set_clip">
<return type="void" />
- <argument index="0" name="item" type="RID" />
- <argument index="1" name="clip" type="bool" />
+ <param index="0" name="item" type="RID" />
+ <param index="1" name="clip" type="bool" />
<description>
</description>
</method>
<method name="canvas_item_set_copy_to_backbuffer">
<return type="void" />
- <argument index="0" name="item" type="RID" />
- <argument index="1" name="enabled" type="bool" />
- <argument index="2" name="rect" type="Rect2" />
+ <param index="0" name="item" type="RID" />
+ <param index="1" name="enabled" type="bool" />
+ <param index="2" name="rect" type="Rect2" />
<description>
Sets the [CanvasItem] to copy a rect to the backbuffer.
</description>
</method>
<method name="canvas_item_set_custom_rect">
<return type="void" />
- <argument index="0" name="item" type="RID" />
- <argument index="1" name="use_custom_rect" type="bool" />
- <argument index="2" name="rect" type="Rect2" default="Rect2(0, 0, 0, 0)" />
+ <param index="0" name="item" type="RID" />
+ <param index="1" name="use_custom_rect" type="bool" />
+ <param index="2" name="rect" type="Rect2" default="Rect2(0, 0, 0, 0)" />
<description>
</description>
</method>
<method name="canvas_item_set_default_texture_filter">
<return type="void" />
- <argument index="0" name="item" type="RID" />
- <argument index="1" name="filter" type="int" enum="RenderingServer.CanvasItemTextureFilter" />
+ <param index="0" name="item" type="RID" />
+ <param index="1" name="filter" type="int" enum="RenderingServer.CanvasItemTextureFilter" />
<description>
</description>
</method>
<method name="canvas_item_set_default_texture_repeat">
<return type="void" />
- <argument index="0" name="item" type="RID" />
- <argument index="1" name="repeat" type="int" enum="RenderingServer.CanvasItemTextureRepeat" />
+ <param index="0" name="item" type="RID" />
+ <param index="1" name="repeat" type="int" enum="RenderingServer.CanvasItemTextureRepeat" />
<description>
</description>
</method>
<method name="canvas_item_set_distance_field_mode">
<return type="void" />
- <argument index="0" name="item" type="RID" />
- <argument index="1" name="enabled" type="bool" />
+ <param index="0" name="item" type="RID" />
+ <param index="1" name="enabled" type="bool" />
<description>
</description>
</method>
<method name="canvas_item_set_draw_behind_parent">
<return type="void" />
- <argument index="0" name="item" type="RID" />
- <argument index="1" name="enabled" type="bool" />
+ <param index="0" name="item" type="RID" />
+ <param index="1" name="enabled" type="bool" />
<description>
</description>
</method>
<method name="canvas_item_set_draw_index">
<return type="void" />
- <argument index="0" name="item" type="RID" />
- <argument index="1" name="index" type="int" />
+ <param index="0" name="item" type="RID" />
+ <param index="1" name="index" type="int" />
<description>
Sets the index for the [CanvasItem].
</description>
</method>
<method name="canvas_item_set_light_mask">
<return type="void" />
- <argument index="0" name="item" type="RID" />
- <argument index="1" name="mask" type="int" />
+ <param index="0" name="item" type="RID" />
+ <param index="1" name="mask" type="int" />
<description>
</description>
</method>
<method name="canvas_item_set_material">
<return type="void" />
- <argument index="0" name="item" type="RID" />
- <argument index="1" name="material" type="RID" />
+ <param index="0" name="item" type="RID" />
+ <param index="1" name="material" type="RID" />
<description>
Sets a new material to the [CanvasItem].
</description>
</method>
<method name="canvas_item_set_modulate">
<return type="void" />
- <argument index="0" name="item" type="RID" />
- <argument index="1" name="color" type="Color" />
+ <param index="0" name="item" type="RID" />
+ <param index="1" name="color" type="Color" />
<description>
</description>
</method>
<method name="canvas_item_set_parent">
<return type="void" />
- <argument index="0" name="item" type="RID" />
- <argument index="1" name="parent" type="RID" />
+ <param index="0" name="item" type="RID" />
+ <param index="1" name="parent" type="RID" />
<description>
</description>
</method>
<method name="canvas_item_set_self_modulate">
<return type="void" />
- <argument index="0" name="item" type="RID" />
- <argument index="1" name="color" type="Color" />
+ <param index="0" name="item" type="RID" />
+ <param index="1" name="color" type="Color" />
<description>
</description>
</method>
<method name="canvas_item_set_sort_children_by_y">
<return type="void" />
- <argument index="0" name="item" type="RID" />
- <argument index="1" name="enabled" type="bool" />
+ <param index="0" name="item" type="RID" />
+ <param index="1" name="enabled" type="bool" />
<description>
</description>
</method>
<method name="canvas_item_set_transform">
<return type="void" />
- <argument index="0" name="item" type="RID" />
- <argument index="1" name="transform" type="Transform2D" />
+ <param index="0" name="item" type="RID" />
+ <param index="1" name="transform" type="Transform2D" />
<description>
</description>
</method>
<method name="canvas_item_set_use_parent_material">
<return type="void" />
- <argument index="0" name="item" type="RID" />
- <argument index="1" name="enabled" type="bool" />
+ <param index="0" name="item" type="RID" />
+ <param index="1" name="enabled" type="bool" />
<description>
Sets if the [CanvasItem] uses its parent's material.
</description>
</method>
<method name="canvas_item_set_visibility_notifier">
<return type="void" />
- <argument index="0" name="item" type="RID" />
- <argument index="1" name="enable" type="bool" />
- <argument index="2" name="area" type="Rect2" />
- <argument index="3" name="enter_callable" type="Callable" />
- <argument index="4" name="exit_callable" type="Callable" />
+ <param index="0" name="item" type="RID" />
+ <param index="1" name="enable" type="bool" />
+ <param index="2" name="area" type="Rect2" />
+ <param index="3" name="enter_callable" type="Callable" />
+ <param index="4" name="exit_callable" type="Callable" />
<description>
</description>
</method>
<method name="canvas_item_set_visible">
<return type="void" />
- <argument index="0" name="item" type="RID" />
- <argument index="1" name="visible" type="bool" />
+ <param index="0" name="item" type="RID" />
+ <param index="1" name="visible" type="bool" />
<description>
</description>
</method>
<method name="canvas_item_set_z_as_relative_to_parent">
<return type="void" />
- <argument index="0" name="item" type="RID" />
- <argument index="1" name="enabled" type="bool" />
+ <param index="0" name="item" type="RID" />
+ <param index="1" name="enabled" type="bool" />
<description>
If this is enabled, the Z index of the parent will be added to the children's Z index.
</description>
</method>
<method name="canvas_item_set_z_index">
<return type="void" />
- <argument index="0" name="item" type="RID" />
- <argument index="1" name="z_index" type="int" />
+ <param index="0" name="item" type="RID" />
+ <param index="1" name="z_index" type="int" />
<description>
Sets the [CanvasItem]'s Z index, i.e. its draw order (lower indexes are drawn first).
</description>
</method>
<method name="canvas_light_attach_to_canvas">
<return type="void" />
- <argument index="0" name="light" type="RID" />
- <argument index="1" name="canvas" type="RID" />
+ <param index="0" name="light" type="RID" />
+ <param index="1" name="canvas" type="RID" />
<description>
Attaches the canvas light to the canvas. Removes it from its previous canvas.
</description>
@@ -514,8 +548,8 @@
</method>
<method name="canvas_light_occluder_attach_to_canvas">
<return type="void" />
- <argument index="0" name="occluder" type="RID" />
- <argument index="1" name="canvas" type="RID" />
+ <param index="0" name="occluder" type="RID" />
+ <param index="1" name="canvas" type="RID" />
<description>
Attaches a light occluder to the canvas. Removes it from its previous canvas.
</description>
@@ -529,177 +563,177 @@
</method>
<method name="canvas_light_occluder_set_as_sdf_collision">
<return type="void" />
- <argument index="0" name="occluder" type="RID" />
- <argument index="1" name="enable" type="bool" />
+ <param index="0" name="occluder" type="RID" />
+ <param index="1" name="enable" type="bool" />
<description>
</description>
</method>
<method name="canvas_light_occluder_set_enabled">
<return type="void" />
- <argument index="0" name="occluder" type="RID" />
- <argument index="1" name="enabled" type="bool" />
+ <param index="0" name="occluder" type="RID" />
+ <param index="1" name="enabled" type="bool" />
<description>
Enables or disables light occluder.
</description>
</method>
<method name="canvas_light_occluder_set_light_mask">
<return type="void" />
- <argument index="0" name="occluder" type="RID" />
- <argument index="1" name="mask" type="int" />
+ <param index="0" name="occluder" type="RID" />
+ <param index="1" name="mask" type="int" />
<description>
The light mask. See [LightOccluder2D] for more information on light masks.
</description>
</method>
<method name="canvas_light_occluder_set_polygon">
<return type="void" />
- <argument index="0" name="occluder" type="RID" />
- <argument index="1" name="polygon" type="RID" />
+ <param index="0" name="occluder" type="RID" />
+ <param index="1" name="polygon" type="RID" />
<description>
Sets a light occluder's polygon.
</description>
</method>
<method name="canvas_light_occluder_set_transform">
<return type="void" />
- <argument index="0" name="occluder" type="RID" />
- <argument index="1" name="transform" type="Transform2D" />
+ <param index="0" name="occluder" type="RID" />
+ <param index="1" name="transform" type="Transform2D" />
<description>
Sets a light occluder's [Transform2D].
</description>
</method>
<method name="canvas_light_set_color">
<return type="void" />
- <argument index="0" name="light" type="RID" />
- <argument index="1" name="color" type="Color" />
+ <param index="0" name="light" type="RID" />
+ <param index="1" name="color" type="Color" />
<description>
Sets the color for a light.
</description>
</method>
<method name="canvas_light_set_enabled">
<return type="void" />
- <argument index="0" name="light" type="RID" />
- <argument index="1" name="enabled" type="bool" />
+ <param index="0" name="light" type="RID" />
+ <param index="1" name="enabled" type="bool" />
<description>
Enables or disables a canvas light.
</description>
</method>
<method name="canvas_light_set_energy">
<return type="void" />
- <argument index="0" name="light" type="RID" />
- <argument index="1" name="energy" type="float" />
+ <param index="0" name="light" type="RID" />
+ <param index="1" name="energy" type="float" />
<description>
Sets a canvas light's energy.
</description>
</method>
<method name="canvas_light_set_height">
<return type="void" />
- <argument index="0" name="light" type="RID" />
- <argument index="1" name="height" type="float" />
+ <param index="0" name="light" type="RID" />
+ <param index="1" name="height" type="float" />
<description>
Sets a canvas light's height.
</description>
</method>
<method name="canvas_light_set_item_cull_mask">
<return type="void" />
- <argument index="0" name="light" type="RID" />
- <argument index="1" name="mask" type="int" />
+ <param index="0" name="light" type="RID" />
+ <param index="1" name="mask" type="int" />
<description>
The light mask. See [LightOccluder2D] for more information on light masks.
</description>
</method>
<method name="canvas_light_set_item_shadow_cull_mask">
<return type="void" />
- <argument index="0" name="light" type="RID" />
- <argument index="1" name="mask" type="int" />
+ <param index="0" name="light" type="RID" />
+ <param index="1" name="mask" type="int" />
<description>
The binary mask used to determine which layers this canvas light's shadows affects. See [LightOccluder2D] for more information on light masks.
</description>
</method>
<method name="canvas_light_set_layer_range">
<return type="void" />
- <argument index="0" name="light" type="RID" />
- <argument index="1" name="min_layer" type="int" />
- <argument index="2" name="max_layer" type="int" />
+ <param index="0" name="light" type="RID" />
+ <param index="1" name="min_layer" type="int" />
+ <param index="2" name="max_layer" type="int" />
<description>
The layer range that gets rendered with this light.
</description>
</method>
<method name="canvas_light_set_mode">
<return type="void" />
- <argument index="0" name="light" type="RID" />
- <argument index="1" name="mode" type="int" enum="RenderingServer.CanvasLightMode" />
+ <param index="0" name="light" type="RID" />
+ <param index="1" name="mode" type="int" enum="RenderingServer.CanvasLightMode" />
<description>
The mode of the light, see [enum CanvasLightMode] constants.
</description>
</method>
<method name="canvas_light_set_shadow_color">
<return type="void" />
- <argument index="0" name="light" type="RID" />
- <argument index="1" name="color" type="Color" />
+ <param index="0" name="light" type="RID" />
+ <param index="1" name="color" type="Color" />
<description>
Sets the color of the canvas light's shadow.
</description>
</method>
<method name="canvas_light_set_shadow_enabled">
<return type="void" />
- <argument index="0" name="light" type="RID" />
- <argument index="1" name="enabled" type="bool" />
+ <param index="0" name="light" type="RID" />
+ <param index="1" name="enabled" type="bool" />
<description>
Enables or disables the canvas light's shadow.
</description>
</method>
<method name="canvas_light_set_shadow_filter">
<return type="void" />
- <argument index="0" name="light" type="RID" />
- <argument index="1" name="filter" type="int" enum="RenderingServer.CanvasLightShadowFilter" />
+ <param index="0" name="light" type="RID" />
+ <param index="1" name="filter" type="int" enum="RenderingServer.CanvasLightShadowFilter" />
<description>
Sets the canvas light's shadow's filter, see [enum CanvasLightShadowFilter] constants.
</description>
</method>
<method name="canvas_light_set_shadow_smooth">
<return type="void" />
- <argument index="0" name="light" type="RID" />
- <argument index="1" name="smooth" type="float" />
+ <param index="0" name="light" type="RID" />
+ <param index="1" name="smooth" type="float" />
<description>
Smoothens the shadow. The lower, the smoother.
</description>
</method>
<method name="canvas_light_set_texture">
<return type="void" />
- <argument index="0" name="light" type="RID" />
- <argument index="1" name="texture" type="RID" />
+ <param index="0" name="light" type="RID" />
+ <param index="1" name="texture" type="RID" />
<description>
Sets the texture to be used by a [PointLight2D]. Equivalent to [member PointLight2D.texture].
</description>
</method>
<method name="canvas_light_set_texture_offset">
<return type="void" />
- <argument index="0" name="light" type="RID" />
- <argument index="1" name="offset" type="Vector2" />
+ <param index="0" name="light" type="RID" />
+ <param index="1" name="offset" type="Vector2" />
<description>
Sets the offset of a [PointLight2D]'s texture. Equivalent to [member PointLight2D.offset].
</description>
</method>
<method name="canvas_light_set_texture_scale">
<return type="void" />
- <argument index="0" name="light" type="RID" />
- <argument index="1" name="scale" type="float" />
+ <param index="0" name="light" type="RID" />
+ <param index="1" name="scale" type="float" />
<description>
Sets the scale factor of a [PointLight2D]'s texture. Equivalent to [member PointLight2D.texture_scale].
</description>
</method>
<method name="canvas_light_set_transform">
<return type="void" />
- <argument index="0" name="light" type="RID" />
- <argument index="1" name="transform" type="Transform2D" />
+ <param index="0" name="light" type="RID" />
+ <param index="1" name="transform" type="Transform2D" />
<description>
Sets the canvas light's [Transform2D].
</description>
</method>
<method name="canvas_light_set_z_range">
<return type="void" />
- <argument index="0" name="light" type="RID" />
- <argument index="1" name="min_z" type="int" />
- <argument index="2" name="max_z" type="int" />
+ <param index="0" name="light" type="RID" />
+ <param index="1" name="min_z" type="int" />
+ <param index="2" name="max_z" type="int" />
<description>
Sets the Z range of objects that will be affected by this light. Equivalent to [member Light2D.range_z_min] and [member Light2D.range_z_max].
</description>
@@ -713,47 +747,47 @@
</method>
<method name="canvas_occluder_polygon_set_cull_mode">
<return type="void" />
- <argument index="0" name="occluder_polygon" type="RID" />
- <argument index="1" name="mode" type="int" enum="RenderingServer.CanvasOccluderPolygonCullMode" />
+ <param index="0" name="occluder_polygon" type="RID" />
+ <param index="1" name="mode" type="int" enum="RenderingServer.CanvasOccluderPolygonCullMode" />
<description>
Sets an occluder polygons cull mode. See [enum CanvasOccluderPolygonCullMode] constants.
</description>
</method>
<method name="canvas_occluder_polygon_set_shape">
<return type="void" />
- <argument index="0" name="occluder_polygon" type="RID" />
- <argument index="1" name="shape" type="PackedVector2Array" />
- <argument index="2" name="closed" type="bool" />
+ <param index="0" name="occluder_polygon" type="RID" />
+ <param index="1" name="shape" type="PackedVector2Array" />
+ <param index="2" name="closed" type="bool" />
<description>
Sets the shape of the occluder polygon.
</description>
</method>
<method name="canvas_set_disable_scale">
<return type="void" />
- <argument index="0" name="disable" type="bool" />
+ <param index="0" name="disable" type="bool" />
<description>
</description>
</method>
<method name="canvas_set_item_mirroring">
<return type="void" />
- <argument index="0" name="canvas" type="RID" />
- <argument index="1" name="item" type="RID" />
- <argument index="2" name="mirroring" type="Vector2" />
+ <param index="0" name="canvas" type="RID" />
+ <param index="1" name="item" type="RID" />
+ <param index="2" name="mirroring" type="Vector2" />
<description>
A copy of the canvas item will be drawn with a local offset of the mirroring [Vector2].
</description>
</method>
<method name="canvas_set_modulate">
<return type="void" />
- <argument index="0" name="canvas" type="RID" />
- <argument index="1" name="color" type="Color" />
+ <param index="0" name="canvas" type="RID" />
+ <param index="1" name="color" type="Color" />
<description>
Modulates all colors in the given canvas.
</description>
</method>
<method name="canvas_set_shadow_texture_size">
<return type="void" />
- <argument index="0" name="size" type="int" />
+ <param index="0" name="size" type="int" />
<description>
</description>
</method>
@@ -764,31 +798,31 @@
</method>
<method name="canvas_texture_set_channel">
<return type="void" />
- <argument index="0" name="canvas_texture" type="RID" />
- <argument index="1" name="channel" type="int" enum="RenderingServer.CanvasTextureChannel" />
- <argument index="2" name="texture" type="RID" />
+ <param index="0" name="canvas_texture" type="RID" />
+ <param index="1" name="channel" type="int" enum="RenderingServer.CanvasTextureChannel" />
+ <param index="2" name="texture" type="RID" />
<description>
</description>
</method>
<method name="canvas_texture_set_shading_parameters">
<return type="void" />
- <argument index="0" name="canvas_texture" type="RID" />
- <argument index="1" name="base_color" type="Color" />
- <argument index="2" name="shininess" type="float" />
+ <param index="0" name="canvas_texture" type="RID" />
+ <param index="1" name="base_color" type="Color" />
+ <param index="2" name="shininess" type="float" />
<description>
</description>
</method>
<method name="canvas_texture_set_texture_filter">
<return type="void" />
- <argument index="0" name="canvas_texture" type="RID" />
- <argument index="1" name="filter" type="int" enum="RenderingServer.CanvasItemTextureFilter" />
+ <param index="0" name="canvas_texture" type="RID" />
+ <param index="1" name="filter" type="int" enum="RenderingServer.CanvasItemTextureFilter" />
<description>
</description>
</method>
<method name="canvas_texture_set_texture_repeat">
<return type="void" />
- <argument index="0" name="canvas_texture" type="RID" />
- <argument index="1" name="repeat" type="int" enum="RenderingServer.CanvasItemTextureRepeat" />
+ <param index="0" name="canvas_texture" type="RID" />
+ <param index="1" name="repeat" type="int" enum="RenderingServer.CanvasItemTextureRepeat" />
<description>
</description>
</method>
@@ -804,74 +838,74 @@
</method>
<method name="decal_set_albedo_mix">
<return type="void" />
- <argument index="0" name="decal" type="RID" />
- <argument index="1" name="albedo_mix" type="float" />
+ <param index="0" name="decal" type="RID" />
+ <param index="1" name="albedo_mix" type="float" />
<description>
</description>
</method>
<method name="decal_set_cull_mask">
<return type="void" />
- <argument index="0" name="decal" type="RID" />
- <argument index="1" name="mask" type="int" />
+ <param index="0" name="decal" type="RID" />
+ <param index="1" name="mask" type="int" />
<description>
</description>
</method>
<method name="decal_set_distance_fade">
<return type="void" />
- <argument index="0" name="decal" type="RID" />
- <argument index="1" name="enabled" type="bool" />
- <argument index="2" name="begin" type="float" />
- <argument index="3" name="length" type="float" />
+ <param index="0" name="decal" type="RID" />
+ <param index="1" name="enabled" type="bool" />
+ <param index="2" name="begin" type="float" />
+ <param index="3" name="length" type="float" />
<description>
</description>
</method>
<method name="decal_set_emission_energy">
<return type="void" />
- <argument index="0" name="decal" type="RID" />
- <argument index="1" name="energy" type="float" />
+ <param index="0" name="decal" type="RID" />
+ <param index="1" name="energy" type="float" />
<description>
</description>
</method>
<method name="decal_set_extents">
<return type="void" />
- <argument index="0" name="decal" type="RID" />
- <argument index="1" name="extents" type="Vector3" />
+ <param index="0" name="decal" type="RID" />
+ <param index="1" name="extents" type="Vector3" />
<description>
</description>
</method>
<method name="decal_set_fade">
<return type="void" />
- <argument index="0" name="decal" type="RID" />
- <argument index="1" name="above" type="float" />
- <argument index="2" name="below" type="float" />
+ <param index="0" name="decal" type="RID" />
+ <param index="1" name="above" type="float" />
+ <param index="2" name="below" type="float" />
<description>
</description>
</method>
<method name="decal_set_modulate">
<return type="void" />
- <argument index="0" name="decal" type="RID" />
- <argument index="1" name="color" type="Color" />
+ <param index="0" name="decal" type="RID" />
+ <param index="1" name="color" type="Color" />
<description>
</description>
</method>
<method name="decal_set_normal_fade">
<return type="void" />
- <argument index="0" name="decal" type="RID" />
- <argument index="1" name="fade" type="float" />
+ <param index="0" name="decal" type="RID" />
+ <param index="1" name="fade" type="float" />
<description>
</description>
</method>
<method name="decal_set_texture">
<return type="void" />
- <argument index="0" name="decal" type="RID" />
- <argument index="1" name="type" type="int" enum="RenderingServer.DecalTexture" />
- <argument index="2" name="texture" type="RID" />
+ <param index="0" name="decal" type="RID" />
+ <param index="1" name="type" type="int" enum="RenderingServer.DecalTexture" />
+ <param index="2" name="texture" type="RID" />
<description>
</description>
</method>
<method name="decals_set_filter">
<return type="void" />
- <argument index="0" name="filter" type="int" enum="RenderingServer.DecalFilter" />
+ <param index="0" name="filter" type="int" enum="RenderingServer.DecalFilter" />
<description>
</description>
</method>
@@ -885,22 +919,22 @@
</method>
<method name="directional_shadow_atlas_set_size">
<return type="void" />
- <argument index="0" name="size" type="int" />
- <argument index="1" name="is_16bits" type="bool" />
+ <param index="0" name="size" type="int" />
+ <param index="1" name="is_16bits" type="bool" />
<description>
</description>
</method>
<method name="directional_soft_shadow_filter_set_quality">
<return type="void" />
- <argument index="0" name="quality" type="int" enum="RenderingServer.ShadowQuality" />
+ <param index="0" name="quality" type="int" enum="RenderingServer.ShadowQuality" />
<description>
</description>
</method>
<method name="environment_bake_panorama">
<return type="Image" />
- <argument index="0" name="environment" type="RID" />
- <argument index="1" name="bake_irradiance" type="bool" />
- <argument index="2" name="size" type="Vector2i" />
+ <param index="0" name="environment" type="RID" />
+ <param index="1" name="bake_irradiance" type="bool" />
+ <param index="2" name="size" type="Vector2i" />
<description>
</description>
</method>
@@ -913,266 +947,264 @@
</method>
<method name="environment_glow_set_use_bicubic_upscale">
<return type="void" />
- <argument index="0" name="enable" type="bool" />
+ <param index="0" name="enable" type="bool" />
<description>
</description>
</method>
<method name="environment_glow_set_use_high_quality">
<return type="void" />
- <argument index="0" name="enable" type="bool" />
+ <param index="0" name="enable" type="bool" />
<description>
</description>
</method>
<method name="environment_set_adjustment">
<return type="void" />
- <argument index="0" name="env" type="RID" />
- <argument index="1" name="enable" type="bool" />
- <argument index="2" name="brightness" type="float" />
- <argument index="3" name="contrast" type="float" />
- <argument index="4" name="saturation" type="float" />
- <argument index="5" name="use_1d_color_correction" type="bool" />
- <argument index="6" name="color_correction" type="RID" />
+ <param index="0" name="env" type="RID" />
+ <param index="1" name="enable" type="bool" />
+ <param index="2" name="brightness" type="float" />
+ <param index="3" name="contrast" type="float" />
+ <param index="4" name="saturation" type="float" />
+ <param index="5" name="use_1d_color_correction" type="bool" />
+ <param index="6" name="color_correction" type="RID" />
<description>
Sets the values to be used with the "Adjustment" post-process effect. See [Environment] for more details.
</description>
</method>
<method name="environment_set_ambient_light">
<return type="void" />
- <argument index="0" name="env" type="RID" />
- <argument index="1" name="color" type="Color" />
- <argument index="2" name="ambient" type="int" enum="RenderingServer.EnvironmentAmbientSource" default="0" />
- <argument index="3" name="energy" type="float" default="1.0" />
- <argument index="4" name="sky_contibution" type="float" default="0.0" />
- <argument index="5" name="reflection_source" type="int" enum="RenderingServer.EnvironmentReflectionSource" default="0" />
+ <param index="0" name="env" type="RID" />
+ <param index="1" name="color" type="Color" />
+ <param index="2" name="ambient" type="int" enum="RenderingServer.EnvironmentAmbientSource" default="0" />
+ <param index="3" name="energy" type="float" default="1.0" />
+ <param index="4" name="sky_contibution" type="float" default="0.0" />
+ <param index="5" name="reflection_source" type="int" enum="RenderingServer.EnvironmentReflectionSource" default="0" />
<description>
</description>
</method>
<method name="environment_set_background">
<return type="void" />
- <argument index="0" name="env" type="RID" />
- <argument index="1" name="bg" type="int" enum="RenderingServer.EnvironmentBG" />
+ <param index="0" name="env" type="RID" />
+ <param index="1" name="bg" type="int" enum="RenderingServer.EnvironmentBG" />
<description>
Sets the [i]BGMode[/i] of the environment. Equivalent to [member Environment.background_mode].
</description>
</method>
<method name="environment_set_bg_color">
<return type="void" />
- <argument index="0" name="env" type="RID" />
- <argument index="1" name="color" type="Color" />
+ <param index="0" name="env" type="RID" />
+ <param index="1" name="color" type="Color" />
<description>
Color displayed for clear areas of the scene (if using Custom color or Color+Sky background modes).
</description>
</method>
<method name="environment_set_bg_energy">
<return type="void" />
- <argument index="0" name="env" type="RID" />
- <argument index="1" name="energy" type="float" />
+ <param index="0" name="env" type="RID" />
+ <param index="1" name="multiplier" type="float" />
+ <param index="2" name="exposure_value" type="float" />
<description>
Sets the intensity of the background color.
</description>
</method>
<method name="environment_set_canvas_max_layer">
<return type="void" />
- <argument index="0" name="env" type="RID" />
- <argument index="1" name="max_layer" type="int" />
+ <param index="0" name="env" type="RID" />
+ <param index="1" name="max_layer" type="int" />
<description>
Sets the maximum layer to use if using Canvas background mode.
</description>
</method>
<method name="environment_set_fog">
<return type="void" />
- <argument index="0" name="env" type="RID" />
- <argument index="1" name="enable" type="bool" />
- <argument index="2" name="light_color" type="Color" />
- <argument index="3" name="light_energy" type="float" />
- <argument index="4" name="sun_scatter" type="float" />
- <argument index="5" name="density" type="float" />
- <argument index="6" name="height" type="float" />
- <argument index="7" name="height_density" type="float" />
- <argument index="8" name="aerial_perspective" type="float" />
+ <param index="0" name="env" type="RID" />
+ <param index="1" name="enable" type="bool" />
+ <param index="2" name="light_color" type="Color" />
+ <param index="3" name="light_energy" type="float" />
+ <param index="4" name="sun_scatter" type="float" />
+ <param index="5" name="density" type="float" />
+ <param index="6" name="height" type="float" />
+ <param index="7" name="height_density" type="float" />
+ <param index="8" name="aerial_perspective" type="float" />
+ <param index="9" name="sky_affect" type="float" />
<description>
</description>
</method>
<method name="environment_set_glow">
<return type="void" />
- <argument index="0" name="env" type="RID" />
- <argument index="1" name="enable" type="bool" />
- <argument index="2" name="levels" type="PackedFloat32Array" />
- <argument index="3" name="intensity" type="float" />
- <argument index="4" name="strength" type="float" />
- <argument index="5" name="mix" type="float" />
- <argument index="6" name="bloom_threshold" type="float" />
- <argument index="7" name="blend_mode" type="int" enum="RenderingServer.EnvironmentGlowBlendMode" />
- <argument index="8" name="hdr_bleed_threshold" type="float" />
- <argument index="9" name="hdr_bleed_scale" type="float" />
- <argument index="10" name="hdr_luminance_cap" type="float" />
- <argument index="11" name="glow_map_strength" type="float" />
- <argument index="12" name="glow_map" type="RID" />
+ <param index="0" name="env" type="RID" />
+ <param index="1" name="enable" type="bool" />
+ <param index="2" name="levels" type="PackedFloat32Array" />
+ <param index="3" name="intensity" type="float" />
+ <param index="4" name="strength" type="float" />
+ <param index="5" name="mix" type="float" />
+ <param index="6" name="bloom_threshold" type="float" />
+ <param index="7" name="blend_mode" type="int" enum="RenderingServer.EnvironmentGlowBlendMode" />
+ <param index="8" name="hdr_bleed_threshold" type="float" />
+ <param index="9" name="hdr_bleed_scale" type="float" />
+ <param index="10" name="hdr_luminance_cap" type="float" />
+ <param index="11" name="glow_map_strength" type="float" />
+ <param index="12" name="glow_map" type="RID" />
<description>
</description>
</method>
<method name="environment_set_sdfgi">
<return type="void" />
- <argument index="0" name="env" type="RID" />
- <argument index="1" name="enable" type="bool" />
- <argument index="2" name="cascades" type="int" />
- <argument index="3" name="min_cell_size" type="float" />
- <argument index="4" name="y_scale" type="int" enum="RenderingServer.EnvironmentSDFGIYScale" />
- <argument index="5" name="use_occlusion" type="bool" />
- <argument index="6" name="bounce_feedback" type="float" />
- <argument index="7" name="read_sky" type="bool" />
- <argument index="8" name="energy" type="float" />
- <argument index="9" name="normal_bias" type="float" />
- <argument index="10" name="probe_bias" type="float" />
+ <param index="0" name="env" type="RID" />
+ <param index="1" name="enable" type="bool" />
+ <param index="2" name="cascades" type="int" />
+ <param index="3" name="min_cell_size" type="float" />
+ <param index="4" name="y_scale" type="int" enum="RenderingServer.EnvironmentSDFGIYScale" />
+ <param index="5" name="use_occlusion" type="bool" />
+ <param index="6" name="bounce_feedback" type="float" />
+ <param index="7" name="read_sky" type="bool" />
+ <param index="8" name="energy" type="float" />
+ <param index="9" name="normal_bias" type="float" />
+ <param index="10" name="probe_bias" type="float" />
<description>
</description>
</method>
<method name="environment_set_sdfgi_frames_to_converge">
<return type="void" />
- <argument index="0" name="frames" type="int" enum="RenderingServer.EnvironmentSDFGIFramesToConverge" />
+ <param index="0" name="frames" type="int" enum="RenderingServer.EnvironmentSDFGIFramesToConverge" />
<description>
</description>
</method>
<method name="environment_set_sdfgi_frames_to_update_light">
<return type="void" />
- <argument index="0" name="frames" type="int" enum="RenderingServer.EnvironmentSDFGIFramesToUpdateLight" />
+ <param index="0" name="frames" type="int" enum="RenderingServer.EnvironmentSDFGIFramesToUpdateLight" />
<description>
</description>
</method>
<method name="environment_set_sdfgi_ray_count">
<return type="void" />
- <argument index="0" name="ray_count" type="int" enum="RenderingServer.EnvironmentSDFGIRayCount" />
+ <param index="0" name="ray_count" type="int" enum="RenderingServer.EnvironmentSDFGIRayCount" />
<description>
</description>
</method>
<method name="environment_set_sky">
<return type="void" />
- <argument index="0" name="env" type="RID" />
- <argument index="1" name="sky" type="RID" />
+ <param index="0" name="env" type="RID" />
+ <param index="1" name="sky" type="RID" />
<description>
Sets the [Sky] to be used as the environment's background when using [i]BGMode[/i] sky. Equivalent to [member Environment.sky].
</description>
</method>
<method name="environment_set_sky_custom_fov">
<return type="void" />
- <argument index="0" name="env" type="RID" />
- <argument index="1" name="scale" type="float" />
+ <param index="0" name="env" type="RID" />
+ <param index="1" name="scale" type="float" />
<description>
Sets a custom field of view for the background [Sky]. Equivalent to [member Environment.sky_custom_fov].
</description>
</method>
<method name="environment_set_sky_orientation">
<return type="void" />
- <argument index="0" name="env" type="RID" />
- <argument index="1" name="orientation" type="Basis" />
+ <param index="0" name="env" type="RID" />
+ <param index="1" name="orientation" type="Basis" />
<description>
Sets the rotation of the background [Sky] expressed as a [Basis]. Equivalent to [member Environment.sky_rotation], where the rotation vector is used to construct the [Basis].
</description>
</method>
<method name="environment_set_ssao">
<return type="void" />
- <argument index="0" name="env" type="RID" />
- <argument index="1" name="enable" type="bool" />
- <argument index="2" name="radius" type="float" />
- <argument index="3" name="intensity" type="float" />
- <argument index="4" name="power" type="float" />
- <argument index="5" name="detail" type="float" />
- <argument index="6" name="horizon" type="float" />
- <argument index="7" name="sharpness" type="float" />
- <argument index="8" name="light_affect" type="float" />
- <argument index="9" name="ao_channel_affect" type="float" />
+ <param index="0" name="env" type="RID" />
+ <param index="1" name="enable" type="bool" />
+ <param index="2" name="radius" type="float" />
+ <param index="3" name="intensity" type="float" />
+ <param index="4" name="power" type="float" />
+ <param index="5" name="detail" type="float" />
+ <param index="6" name="horizon" type="float" />
+ <param index="7" name="sharpness" type="float" />
+ <param index="8" name="light_affect" type="float" />
+ <param index="9" name="ao_channel_affect" type="float" />
<description>
Sets the variables to be used with the screen-space ambient occlusion (SSAO) post-process effect. See [Environment] for more details.
</description>
</method>
<method name="environment_set_ssao_quality">
<return type="void" />
- <argument index="0" name="quality" type="int" enum="RenderingServer.EnvironmentSSAOQuality" />
- <argument index="1" name="half_size" type="bool" />
- <argument index="2" name="adaptive_target" type="float" />
- <argument index="3" name="blur_passes" type="int" />
- <argument index="4" name="fadeout_from" type="float" />
- <argument index="5" name="fadeout_to" type="float" />
+ <param index="0" name="quality" type="int" enum="RenderingServer.EnvironmentSSAOQuality" />
+ <param index="1" name="half_size" type="bool" />
+ <param index="2" name="adaptive_target" type="float" />
+ <param index="3" name="blur_passes" type="int" />
+ <param index="4" name="fadeout_from" type="float" />
+ <param index="5" name="fadeout_to" type="float" />
<description>
Sets the quality level of the screen-space ambient occlusion (SSAO) post-process effect. See [Environment] for more details.
</description>
</method>
<method name="environment_set_ssil_quality">
<return type="void" />
- <argument index="0" name="quality" type="int" enum="RenderingServer.EnvironmentSSILQuality" />
- <argument index="1" name="half_size" type="bool" />
- <argument index="2" name="adaptive_target" type="float" />
- <argument index="3" name="blur_passes" type="int" />
- <argument index="4" name="fadeout_from" type="float" />
- <argument index="5" name="fadeout_to" type="float" />
+ <param index="0" name="quality" type="int" enum="RenderingServer.EnvironmentSSILQuality" />
+ <param index="1" name="half_size" type="bool" />
+ <param index="2" name="adaptive_target" type="float" />
+ <param index="3" name="blur_passes" type="int" />
+ <param index="4" name="fadeout_from" type="float" />
+ <param index="5" name="fadeout_to" type="float" />
<description>
Sets the quality level of the screen-space indirect lighting (SSIL) post-process effect. See [Environment] for more details.
</description>
</method>
<method name="environment_set_ssr">
<return type="void" />
- <argument index="0" name="env" type="RID" />
- <argument index="1" name="enable" type="bool" />
- <argument index="2" name="max_steps" type="int" />
- <argument index="3" name="fade_in" type="float" />
- <argument index="4" name="fade_out" type="float" />
- <argument index="5" name="depth_tolerance" type="float" />
+ <param index="0" name="env" type="RID" />
+ <param index="1" name="enable" type="bool" />
+ <param index="2" name="max_steps" type="int" />
+ <param index="3" name="fade_in" type="float" />
+ <param index="4" name="fade_out" type="float" />
+ <param index="5" name="depth_tolerance" type="float" />
<description>
Sets the variables to be used with the "screen space reflections" post-process effect. See [Environment] for more details.
</description>
</method>
<method name="environment_set_ssr_roughness_quality">
<return type="void" />
- <argument index="0" name="quality" type="int" enum="RenderingServer.EnvironmentSSRRoughnessQuality" />
+ <param index="0" name="quality" type="int" enum="RenderingServer.EnvironmentSSRRoughnessQuality" />
<description>
</description>
</method>
<method name="environment_set_tonemap">
<return type="void" />
- <argument index="0" name="env" type="RID" />
- <argument index="1" name="tone_mapper" type="int" enum="RenderingServer.EnvironmentToneMapper" />
- <argument index="2" name="exposure" type="float" />
- <argument index="3" name="white" type="float" />
- <argument index="4" name="auto_exposure" type="bool" />
- <argument index="5" name="min_luminance" type="float" />
- <argument index="6" name="max_luminance" type="float" />
- <argument index="7" name="auto_exp_speed" type="float" />
- <argument index="8" name="auto_exp_grey" type="float" />
+ <param index="0" name="env" type="RID" />
+ <param index="1" name="tone_mapper" type="int" enum="RenderingServer.EnvironmentToneMapper" />
+ <param index="2" name="exposure" type="float" />
+ <param index="3" name="white" type="float" />
<description>
Sets the variables to be used with the "tonemap" post-process effect. See [Environment] for more details.
</description>
</method>
<method name="environment_set_volumetric_fog">
<return type="void" />
- <argument index="0" name="env" type="RID" />
- <argument index="1" name="enable" type="bool" />
- <argument index="2" name="density" type="float" />
- <argument index="3" name="albedo" type="Color" />
- <argument index="4" name="emission" type="Color" />
- <argument index="5" name="emission_energy" type="float" />
- <argument index="6" name="anisotropy" type="float" />
- <argument index="7" name="length" type="float" />
- <argument index="8" name="p_detail_spread" type="float" />
- <argument index="9" name="gi_inject" type="float" />
- <argument index="10" name="temporal_reprojection" type="bool" />
- <argument index="11" name="temporal_reprojection_amount" type="float" />
- <argument index="12" name="ambient_inject" type="float" />
+ <param index="0" name="env" type="RID" />
+ <param index="1" name="enable" type="bool" />
+ <param index="2" name="density" type="float" />
+ <param index="3" name="albedo" type="Color" />
+ <param index="4" name="emission" type="Color" />
+ <param index="5" name="emission_energy" type="float" />
+ <param index="6" name="anisotropy" type="float" />
+ <param index="7" name="length" type="float" />
+ <param index="8" name="p_detail_spread" type="float" />
+ <param index="9" name="gi_inject" type="float" />
+ <param index="10" name="temporal_reprojection" type="bool" />
+ <param index="11" name="temporal_reprojection_amount" type="float" />
+ <param index="12" name="ambient_inject" type="float" />
+ <param index="13" name="sky_affect" type="float" />
<description>
</description>
</method>
<method name="environment_set_volumetric_fog_filter_active">
<return type="void" />
- <argument index="0" name="active" type="bool" />
+ <param index="0" name="active" type="bool" />
<description>
Enables filtering of the volumetric fog scattering buffer. This results in much smoother volumes with very few under-sampling artifacts.
</description>
</method>
<method name="environment_set_volumetric_fog_volume_size">
<return type="void" />
- <argument index="0" name="size" type="int" />
- <argument index="1" name="depth" type="int" />
+ <param index="0" name="size" type="int" />
+ <param index="1" name="depth" type="int" />
<description>
- Sets the resolution of the volumetric fog's froxel buffer. [code]size[/code] is modified by the screen's aspect ratio and then used to set the width and height of the buffer. While [code]depth[/code] is directly used to set the depth of the buffer.
+ Sets the resolution of the volumetric fog's froxel buffer. [param size] is modified by the screen's aspect ratio and then used to set the width and height of the buffer. While [param depth] is directly used to set the depth of the buffer.
</description>
</method>
<method name="fog_volume_create">
@@ -1183,32 +1215,32 @@
</method>
<method name="fog_volume_set_extents">
<return type="void" />
- <argument index="0" name="fog_volume" type="RID" />
- <argument index="1" name="extents" type="Vector3" />
+ <param index="0" name="fog_volume" type="RID" />
+ <param index="1" name="extents" type="Vector3" />
<description>
Sets the size of the fog volume when shape is [constant RenderingServer.FOG_VOLUME_SHAPE_ELLIPSOID], [constant RenderingServer.FOG_VOLUME_SHAPE_CONE], [constant RenderingServer.FOG_VOLUME_SHAPE_CYLINDER] or [constant RenderingServer.FOG_VOLUME_SHAPE_BOX].
</description>
</method>
<method name="fog_volume_set_material">
<return type="void" />
- <argument index="0" name="fog_volume" type="RID" />
- <argument index="1" name="material" type="RID" />
+ <param index="0" name="fog_volume" type="RID" />
+ <param index="1" name="material" type="RID" />
<description>
Sets the [Material] of the fog volume. Can be either a [FogMaterial] or a custom [ShaderMaterial].
</description>
</method>
<method name="fog_volume_set_shape">
<return type="void" />
- <argument index="0" name="fog_volume" type="RID" />
- <argument index="1" name="shape" type="int" enum="RenderingServer.FogVolumeShape" />
+ <param index="0" name="fog_volume" type="RID" />
+ <param index="1" name="shape" type="int" enum="RenderingServer.FogVolumeShape" />
<description>
Sets the shape of the fog volume to either [constant RenderingServer.FOG_VOLUME_SHAPE_ELLIPSOID], [constant RenderingServer.FOG_VOLUME_SHAPE_CONE], [constant RenderingServer.FOG_VOLUME_SHAPE_CYLINDER], [constant RenderingServer.FOG_VOLUME_SHAPE_BOX] or [constant RenderingServer.FOG_VOLUME_SHAPE_WORLD].
</description>
</method>
<method name="force_draw">
<return type="void" />
- <argument index="0" name="swap_buffers" type="bool" default="true" />
- <argument index="1" name="frame_step" type="float" default="0.0" />
+ <param index="0" name="swap_buffers" type="bool" default="true" />
+ <param index="1" name="frame_step" type="float" default="0.0" />
<description>
</description>
</method>
@@ -1219,7 +1251,7 @@
</method>
<method name="free_rid">
<return type="void" />
- <argument index="0" name="rid" type="RID" />
+ <param index="0" name="rid" type="RID" />
<description>
Tries to free an object in the RenderingServer.
</description>
@@ -1236,10 +1268,17 @@
</method>
<method name="get_rendering_info">
<return type="int" />
- <argument index="0" name="info" type="int" enum="RenderingServer.RenderingInfo" />
+ <param index="0" name="info" type="int" enum="RenderingServer.RenderingInfo" />
<description>
</description>
</method>
+ <method name="get_shader_parameter_list" qualifiers="const">
+ <return type="Dictionary[]" />
+ <param index="0" name="shader" type="RID" />
+ <description>
+ Returns the parameters of a shader.
+ </description>
+ </method>
<method name="get_test_cube">
<return type="RID" />
<description>
@@ -1288,53 +1327,53 @@
</method>
<method name="gi_set_use_half_resolution">
<return type="void" />
- <argument index="0" name="half_resolution" type="bool" />
+ <param index="0" name="half_resolution" type="bool" />
<description>
- If [code]half_resolution[/code] is [code]true[/code], renders [VoxelGI] and SDFGI ([member Environment.sdfgi_enabled]) buffers at halved resolution (e.g. 960×540 when the viewport size is 1920×1080). This improves performance significantly when VoxelGI or SDFGI is enabled, at the cost of artifacts that may be visible on polygon edges. The loss in quality becomes less noticeable as the viewport resolution increases. [LightmapGI] rendering is not affected by this setting. See also [member ProjectSettings.rendering/global_illumination/gi/use_half_resolution].
+ If [param half_resolution] is [code]true[/code], renders [VoxelGI] and SDFGI ([member Environment.sdfgi_enabled]) buffers at halved resolution (e.g. 960×540 when the viewport size is 1920×1080). This improves performance significantly when VoxelGI or SDFGI is enabled, at the cost of artifacts that may be visible on polygon edges. The loss in quality becomes less noticeable as the viewport resolution increases. [LightmapGI] rendering is not affected by this setting. See also [member ProjectSettings.rendering/global_illumination/gi/use_half_resolution].
</description>
</method>
- <method name="global_variable_add">
+ <method name="global_shader_parameter_add">
<return type="void" />
- <argument index="0" name="name" type="StringName" />
- <argument index="1" name="type" type="int" enum="RenderingServer.GlobalVariableType" />
- <argument index="2" name="default_value" type="Variant" />
+ <param index="0" name="name" type="StringName" />
+ <param index="1" name="type" type="int" enum="RenderingServer.GlobalShaderParameterType" />
+ <param index="2" name="default_value" type="Variant" />
<description>
</description>
</method>
- <method name="global_variable_get" qualifiers="const">
+ <method name="global_shader_parameter_get" qualifiers="const">
<return type="Variant" />
- <argument index="0" name="name" type="StringName" />
+ <param index="0" name="name" type="StringName" />
<description>
</description>
</method>
- <method name="global_variable_get_list" qualifiers="const">
+ <method name="global_shader_parameter_get_list" qualifiers="const">
<return type="PackedStringArray" />
<description>
</description>
</method>
- <method name="global_variable_get_type" qualifiers="const">
- <return type="int" enum="RenderingServer.GlobalVariableType" />
- <argument index="0" name="name" type="StringName" />
+ <method name="global_shader_parameter_get_type" qualifiers="const">
+ <return type="int" enum="RenderingServer.GlobalShaderParameterType" />
+ <param index="0" name="name" type="StringName" />
<description>
</description>
</method>
- <method name="global_variable_remove">
+ <method name="global_shader_parameter_remove">
<return type="void" />
- <argument index="0" name="name" type="StringName" />
+ <param index="0" name="name" type="StringName" />
<description>
</description>
</method>
- <method name="global_variable_set">
+ <method name="global_shader_parameter_set">
<return type="void" />
- <argument index="0" name="name" type="StringName" />
- <argument index="1" name="value" type="Variant" />
+ <param index="0" name="name" type="StringName" />
+ <param index="1" name="value" type="Variant" />
<description>
</description>
</method>
- <method name="global_variable_set_override">
+ <method name="global_shader_parameter_set_override">
<return type="void" />
- <argument index="0" name="name" type="StringName" />
- <argument index="1" name="value" type="Variant" />
+ <param index="0" name="name" type="StringName" />
+ <param index="1" name="value" type="Variant" />
<description>
</description>
</method>
@@ -1346,30 +1385,30 @@
</method>
<method name="has_feature" qualifiers="const">
<return type="bool" />
- <argument index="0" name="feature" type="int" enum="RenderingServer.Features" />
+ <param index="0" name="feature" type="int" enum="RenderingServer.Features" />
<description>
Not yet implemented. Always returns [code]false[/code].
</description>
</method>
<method name="has_os_feature" qualifiers="const">
<return type="bool" />
- <argument index="0" name="feature" type="String" />
+ <param index="0" name="feature" type="String" />
<description>
- Returns [code]true[/code] if the OS supports a certain feature. Features might be [code]s3tc[/code], [code]etc[/code], and [code]etc2[/code].
+ Returns [code]true[/code] if the OS supports a certain [param feature]. Features might be [code]s3tc[/code], [code]etc[/code], and [code]etc2[/code].
</description>
</method>
<method name="instance_attach_object_instance_id">
<return type="void" />
- <argument index="0" name="instance" type="RID" />
- <argument index="1" name="id" type="int" />
+ <param index="0" name="instance" type="RID" />
+ <param index="1" name="id" type="int" />
<description>
Attaches a unique Object ID to instance. Object ID must be attached to instance for proper culling with [method instances_cull_aabb], [method instances_cull_convex], and [method instances_cull_ray].
</description>
</method>
<method name="instance_attach_skeleton">
<return type="void" />
- <argument index="0" name="instance" type="RID" />
- <argument index="1" name="skeleton" type="RID" />
+ <param index="0" name="instance" type="RID" />
+ <param index="1" name="skeleton" type="RID" />
<description>
Attaches a skeleton to an instance. Removes the previous skeleton from the instance.
</description>
@@ -1384,8 +1423,8 @@
</method>
<method name="instance_create2">
<return type="RID" />
- <argument index="0" name="base" type="RID" />
- <argument index="1" name="scenario" type="RID" />
+ <param index="0" name="base" type="RID" />
+ <param index="1" name="scenario" type="RID" />
<description>
Creates a visual instance, adds it to the RenderingServer, and sets both base and scenario. It can be accessed with the RID that is returned. This RID will be used in all [code]instance_*[/code] RenderingServer functions.
Once finished with your RID, you will want to free the RID using the RenderingServer's [method free_rid] static method.
@@ -1393,216 +1432,216 @@
</method>
<method name="instance_geometry_get_shader_parameter" qualifiers="const">
<return type="Variant" />
- <argument index="0" name="instance" type="RID" />
- <argument index="1" name="parameter" type="StringName" />
+ <param index="0" name="instance" type="RID" />
+ <param index="1" name="parameter" type="StringName" />
<description>
</description>
</method>
<method name="instance_geometry_get_shader_parameter_default_value" qualifiers="const">
<return type="Variant" />
- <argument index="0" name="instance" type="RID" />
- <argument index="1" name="parameter" type="StringName" />
+ <param index="0" name="instance" type="RID" />
+ <param index="1" name="parameter" type="StringName" />
<description>
</description>
</method>
<method name="instance_geometry_get_shader_parameter_list" qualifiers="const">
- <return type="Array" />
- <argument index="0" name="instance" type="RID" />
+ <return type="Dictionary[]" />
+ <param index="0" name="instance" type="RID" />
<description>
</description>
</method>
<method name="instance_geometry_set_cast_shadows_setting">
<return type="void" />
- <argument index="0" name="instance" type="RID" />
- <argument index="1" name="shadow_casting_setting" type="int" enum="RenderingServer.ShadowCastingSetting" />
+ <param index="0" name="instance" type="RID" />
+ <param index="1" name="shadow_casting_setting" type="int" enum="RenderingServer.ShadowCastingSetting" />
<description>
Sets the shadow casting setting to one of [enum ShadowCastingSetting]. Equivalent to [member GeometryInstance3D.cast_shadow].
</description>
</method>
<method name="instance_geometry_set_flag">
<return type="void" />
- <argument index="0" name="instance" type="RID" />
- <argument index="1" name="flag" type="int" enum="RenderingServer.InstanceFlags" />
- <argument index="2" name="enabled" type="bool" />
+ <param index="0" name="instance" type="RID" />
+ <param index="1" name="flag" type="int" enum="RenderingServer.InstanceFlags" />
+ <param index="2" name="enabled" type="bool" />
<description>
Sets the flag for a given [enum InstanceFlags]. See [enum InstanceFlags] for more details.
</description>
</method>
<method name="instance_geometry_set_lightmap">
<return type="void" />
- <argument index="0" name="instance" type="RID" />
- <argument index="1" name="lightmap" type="RID" />
- <argument index="2" name="lightmap_uv_scale" type="Rect2" />
- <argument index="3" name="lightmap_slice" type="int" />
+ <param index="0" name="instance" type="RID" />
+ <param index="1" name="lightmap" type="RID" />
+ <param index="2" name="lightmap_uv_scale" type="Rect2" />
+ <param index="3" name="lightmap_slice" type="int" />
<description>
</description>
</method>
<method name="instance_geometry_set_lod_bias">
<return type="void" />
- <argument index="0" name="instance" type="RID" />
- <argument index="1" name="lod_bias" type="float" />
+ <param index="0" name="instance" type="RID" />
+ <param index="1" name="lod_bias" type="float" />
<description>
</description>
</method>
<method name="instance_geometry_set_material_overlay">
<return type="void" />
- <argument index="0" name="instance" type="RID" />
- <argument index="1" name="material" type="RID" />
+ <param index="0" name="instance" type="RID" />
+ <param index="1" name="material" type="RID" />
<description>
Sets a material that will be rendered for all surfaces on top of active materials for the mesh associated with this instance. Equivalent to [member GeometryInstance3D.material_overlay].
</description>
</method>
<method name="instance_geometry_set_material_override">
<return type="void" />
- <argument index="0" name="instance" type="RID" />
- <argument index="1" name="material" type="RID" />
+ <param index="0" name="instance" type="RID" />
+ <param index="1" name="material" type="RID" />
<description>
Sets a material that will override the material for all surfaces on the mesh associated with this instance. Equivalent to [member GeometryInstance3D.material_override].
</description>
</method>
<method name="instance_geometry_set_shader_parameter">
<return type="void" />
- <argument index="0" name="instance" type="RID" />
- <argument index="1" name="parameter" type="StringName" />
- <argument index="2" name="value" type="Variant" />
+ <param index="0" name="instance" type="RID" />
+ <param index="1" name="parameter" type="StringName" />
+ <param index="2" name="value" type="Variant" />
<description>
</description>
</method>
<method name="instance_geometry_set_transparency">
<return type="void" />
- <argument index="0" name="instance" type="RID" />
- <argument index="1" name="transparency" type="float" />
+ <param index="0" name="instance" type="RID" />
+ <param index="1" name="transparency" type="float" />
<description>
Sets the transparency for the given geometry instance. Equivalent to [member GeometryInstance3D.transparency].
- A transparency of [code]0.0[/code] is fully opaque, while [code]1.0[/code] is fully transparent. Values greater than [code]0.0[/code] (exclusive) will force the geometry's materials to go through the transparent pipeline, which is slower to render and can exhibit rendering issues due to incorrect transparency sorting. However, unlike using a transparent material, setting [code]transparency[/code] to a value greater than [code]0.0[/code] (exclusive) will [i]not[/i] disable shadow rendering.
+ A transparency of [code]0.0[/code] is fully opaque, while [code]1.0[/code] is fully transparent. Values greater than [code]0.0[/code] (exclusive) will force the geometry's materials to go through the transparent pipeline, which is slower to render and can exhibit rendering issues due to incorrect transparency sorting. However, unlike using a transparent material, setting [param transparency] to a value greater than [code]0.0[/code] (exclusive) will [i]not[/i] disable shadow rendering.
In spatial shaders, [code]1.0 - transparency[/code] is set as the default value of the [code]ALPHA[/code] built-in.
- [b]Note:[/b] [code]transparency[/code] is clamped between [code]0.0[/code] and [code]1.0[/code], so this property cannot be used to make transparent materials more opaque than they originally are.
+ [b]Note:[/b] [param transparency] is clamped between [code]0.0[/code] and [code]1.0[/code], so this property cannot be used to make transparent materials more opaque than they originally are.
</description>
</method>
<method name="instance_geometry_set_visibility_range">
<return type="void" />
- <argument index="0" name="instance" type="RID" />
- <argument index="1" name="min" type="float" />
- <argument index="2" name="max" type="float" />
- <argument index="3" name="min_margin" type="float" />
- <argument index="4" name="max_margin" type="float" />
- <argument index="5" name="fade_mode" type="int" enum="RenderingServer.VisibilityRangeFadeMode" />
+ <param index="0" name="instance" type="RID" />
+ <param index="1" name="min" type="float" />
+ <param index="2" name="max" type="float" />
+ <param index="3" name="min_margin" type="float" />
+ <param index="4" name="max_margin" type="float" />
+ <param index="5" name="fade_mode" type="int" enum="RenderingServer.VisibilityRangeFadeMode" />
<description>
Sets the visibility range values for the given geometry instance. Equivalent to [member GeometryInstance3D.visibility_range_begin] and related properties.
</description>
</method>
<method name="instance_set_base">
<return type="void" />
- <argument index="0" name="instance" type="RID" />
- <argument index="1" name="base" type="RID" />
+ <param index="0" name="instance" type="RID" />
+ <param index="1" name="base" type="RID" />
<description>
Sets the base of the instance. A base can be any of the 3D objects that are created in the RenderingServer that can be displayed. For example, any of the light types, mesh, multimesh, immediate geometry, particle system, reflection probe, lightmap, and the GI probe are all types that can be set as the base of an instance in order to be displayed in the scenario.
</description>
</method>
<method name="instance_set_blend_shape_weight">
<return type="void" />
- <argument index="0" name="instance" type="RID" />
- <argument index="1" name="shape" type="int" />
- <argument index="2" name="weight" type="float" />
+ <param index="0" name="instance" type="RID" />
+ <param index="1" name="shape" type="int" />
+ <param index="2" name="weight" type="float" />
<description>
Sets the weight for a given blend shape associated with this instance.
</description>
</method>
<method name="instance_set_custom_aabb">
<return type="void" />
- <argument index="0" name="instance" type="RID" />
- <argument index="1" name="aabb" type="AABB" />
+ <param index="0" name="instance" type="RID" />
+ <param index="1" name="aabb" type="AABB" />
<description>
Sets a custom AABB to use when culling objects from the view frustum. Equivalent to [method GeometryInstance3D.set_custom_aabb].
</description>
</method>
<method name="instance_set_extra_visibility_margin">
<return type="void" />
- <argument index="0" name="instance" type="RID" />
- <argument index="1" name="margin" type="float" />
+ <param index="0" name="instance" type="RID" />
+ <param index="1" name="margin" type="float" />
<description>
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 [member GeometryInstance3D.extra_cull_margin].
</description>
</method>
<method name="instance_set_ignore_culling">
<return type="void" />
- <argument index="0" name="instance" type="RID" />
- <argument index="1" name="enabled" type="bool" />
+ <param index="0" name="instance" type="RID" />
+ <param index="1" name="enabled" type="bool" />
<description>
</description>
</method>
<method name="instance_set_layer_mask">
<return type="void" />
- <argument index="0" name="instance" type="RID" />
- <argument index="1" name="mask" type="int" />
+ <param index="0" name="instance" type="RID" />
+ <param index="1" name="mask" type="int" />
<description>
Sets the render layers that this instance will be drawn to. Equivalent to [member VisualInstance3D.layers].
</description>
</method>
<method name="instance_set_scenario">
<return type="void" />
- <argument index="0" name="instance" type="RID" />
- <argument index="1" name="scenario" type="RID" />
+ <param index="0" name="instance" type="RID" />
+ <param index="1" name="scenario" type="RID" />
<description>
Sets the scenario that the instance is in. The scenario is the 3D world that the objects will be displayed in.
</description>
</method>
<method name="instance_set_surface_override_material">
<return type="void" />
- <argument index="0" name="instance" type="RID" />
- <argument index="1" name="surface" type="int" />
- <argument index="2" name="material" type="RID" />
+ <param index="0" name="instance" type="RID" />
+ <param index="1" name="surface" type="int" />
+ <param index="2" name="material" type="RID" />
<description>
Sets the override material of a specific surface. Equivalent to [method MeshInstance3D.set_surface_override_material].
</description>
</method>
<method name="instance_set_transform">
<return type="void" />
- <argument index="0" name="instance" type="RID" />
- <argument index="1" name="transform" type="Transform3D" />
+ <param index="0" name="instance" type="RID" />
+ <param index="1" name="transform" type="Transform3D" />
<description>
Sets the world space transform of the instance. Equivalent to [member Node3D.transform].
</description>
</method>
<method name="instance_set_visibility_parent">
<return type="void" />
- <argument index="0" name="instance" type="RID" />
- <argument index="1" name="parent" type="RID" />
+ <param index="0" name="instance" type="RID" />
+ <param index="1" name="parent" type="RID" />
<description>
Sets the visibility parent for the given instance. Equivalent to [member Node3D.visibility_parent].
</description>
</method>
<method name="instance_set_visible">
<return type="void" />
- <argument index="0" name="instance" type="RID" />
- <argument index="1" name="visible" type="bool" />
+ <param index="0" name="instance" type="RID" />
+ <param index="1" name="visible" type="bool" />
<description>
Sets whether an instance is drawn or not. Equivalent to [member Node3D.visible].
</description>
</method>
<method name="instances_cull_aabb" qualifiers="const">
- <return type="Array" />
- <argument index="0" name="aabb" type="AABB" />
- <argument index="1" name="scenario" type="RID" />
+ <return type="PackedInt64Array" />
+ <param index="0" name="aabb" type="AABB" />
+ <param index="1" name="scenario" type="RID" />
<description>
Returns an array of object IDs intersecting with the provided AABB. Only visual 3D nodes are considered, such as [MeshInstance3D] or [DirectionalLight3D]. Use [method @GlobalScope.instance_from_id] to obtain the actual nodes. A scenario RID must be provided, which is available in the [World3D] you want to query. This forces an update for all resources queued to update.
[b]Warning:[/b] This function is primarily intended for editor usage. For in-game use cases, prefer physics collision.
</description>
</method>
<method name="instances_cull_convex" qualifiers="const">
- <return type="Array" />
- <argument index="0" name="convex" type="Array" />
- <argument index="1" name="scenario" type="RID" />
+ <return type="PackedInt64Array" />
+ <param index="0" name="convex" type="Plane[]" />
+ <param index="1" name="scenario" type="RID" />
<description>
Returns an array of object IDs intersecting with the provided convex shape. Only visual 3D nodes are considered, such as [MeshInstance3D] or [DirectionalLight3D]. Use [method @GlobalScope.instance_from_id] to obtain the actual nodes. A scenario RID must be provided, which is available in the [World3D] you want to query. This forces an update for all resources queued to update.
[b]Warning:[/b] This function is primarily intended for editor usage. For in-game use cases, prefer physics collision.
</description>
</method>
<method name="instances_cull_ray" qualifiers="const">
- <return type="Array" />
- <argument index="0" name="from" type="Vector3" />
- <argument index="1" name="to" type="Vector3" />
- <argument index="2" name="scenario" type="RID" />
+ <return type="PackedInt64Array" />
+ <param index="0" name="from" type="Vector3" />
+ <param index="1" name="to" type="Vector3" />
+ <param index="2" name="scenario" type="RID" />
<description>
Returns an array of object IDs intersecting with the provided 3D ray. Only visual 3D nodes are considered, such as [MeshInstance3D] or [DirectionalLight3D]. Use [method @GlobalScope.instance_from_id] to obtain the actual nodes. A scenario RID must be provided, which is available in the [World3D] you want to query. This forces an update for all resources queued to update.
[b]Warning:[/b] This function is primarily intended for editor usage. For in-game use cases, prefer physics collision.
@@ -1610,120 +1649,120 @@
</method>
<method name="light_directional_set_blend_splits">
<return type="void" />
- <argument index="0" name="light" type="RID" />
- <argument index="1" name="enable" type="bool" />
+ <param index="0" name="light" type="RID" />
+ <param index="1" name="enable" type="bool" />
<description>
If [code]true[/code], this directional light will blend between shadow map splits resulting in a smoother transition between them. Equivalent to [member DirectionalLight3D.directional_shadow_blend_splits].
</description>
</method>
<method name="light_directional_set_shadow_mode">
<return type="void" />
- <argument index="0" name="light" type="RID" />
- <argument index="1" name="mode" type="int" enum="RenderingServer.LightDirectionalShadowMode" />
+ <param index="0" name="light" type="RID" />
+ <param index="1" name="mode" type="int" enum="RenderingServer.LightDirectionalShadowMode" />
<description>
Sets the shadow mode for this directional light. Equivalent to [member DirectionalLight3D.directional_shadow_mode]. See [enum LightDirectionalShadowMode] for options.
</description>
</method>
<method name="light_directional_set_sky_mode">
<return type="void" />
- <argument index="0" name="light" type="RID" />
- <argument index="1" name="mode" type="int" enum="RenderingServer.LightDirectionalSkyMode" />
+ <param index="0" name="light" type="RID" />
+ <param index="1" name="mode" type="int" enum="RenderingServer.LightDirectionalSkyMode" />
<description>
If [code]true[/code], this light will not be used for anything except sky shaders. Use this for lights that impact your sky shader that you may want to hide from affecting the rest of the scene. For example, you may want to enable this when the sun in your sky shader falls below the horizon.
</description>
</method>
<method name="light_omni_set_shadow_mode">
<return type="void" />
- <argument index="0" name="light" type="RID" />
- <argument index="1" name="mode" type="int" enum="RenderingServer.LightOmniShadowMode" />
+ <param index="0" name="light" type="RID" />
+ <param index="1" name="mode" type="int" enum="RenderingServer.LightOmniShadowMode" />
<description>
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 [member OmniLight3D.omni_shadow_mode].
</description>
</method>
<method name="light_projectors_set_filter">
<return type="void" />
- <argument index="0" name="filter" type="int" enum="RenderingServer.LightProjectorFilter" />
+ <param index="0" name="filter" type="int" enum="RenderingServer.LightProjectorFilter" />
<description>
</description>
</method>
<method name="light_set_bake_mode">
<return type="void" />
- <argument index="0" name="light" type="RID" />
- <argument index="1" name="bake_mode" type="int" enum="RenderingServer.LightBakeMode" />
+ <param index="0" name="light" type="RID" />
+ <param index="1" name="bake_mode" type="int" enum="RenderingServer.LightBakeMode" />
<description>
</description>
</method>
<method name="light_set_color">
<return type="void" />
- <argument index="0" name="light" type="RID" />
- <argument index="1" name="color" type="Color" />
+ <param index="0" name="light" type="RID" />
+ <param index="1" name="color" type="Color" />
<description>
Sets the color of the light. Equivalent to [member Light3D.light_color].
</description>
</method>
<method name="light_set_cull_mask">
<return type="void" />
- <argument index="0" name="light" type="RID" />
- <argument index="1" name="mask" type="int" />
+ <param index="0" name="light" type="RID" />
+ <param index="1" name="mask" type="int" />
<description>
Sets the cull mask for this Light3D. Lights only affect objects in the selected layers. Equivalent to [member Light3D.light_cull_mask].
</description>
</method>
<method name="light_set_distance_fade">
<return type="void" />
- <argument index="0" name="decal" type="RID" />
- <argument index="1" name="enabled" type="bool" />
- <argument index="2" name="begin" type="float" />
- <argument index="3" name="shadow" type="float" />
- <argument index="4" name="length" type="float" />
+ <param index="0" name="decal" type="RID" />
+ <param index="1" name="enabled" type="bool" />
+ <param index="2" name="begin" type="float" />
+ <param index="3" name="shadow" type="float" />
+ <param index="4" name="length" type="float" />
<description>
Sets the distance fade for this Light3D. This acts as a form of level of detail (LOD) and can be used to improve performance. Equivalent to [member Light3D.distance_fade_enabled], [member Light3D.distance_fade_begin], [member Light3D.distance_fade_shadow], and [member Light3D.distance_fade_length].
</description>
</method>
<method name="light_set_max_sdfgi_cascade">
<return type="void" />
- <argument index="0" name="light" type="RID" />
- <argument index="1" name="cascade" type="int" />
+ <param index="0" name="light" type="RID" />
+ <param index="1" name="cascade" type="int" />
<description>
</description>
</method>
<method name="light_set_negative">
<return type="void" />
- <argument index="0" name="light" type="RID" />
- <argument index="1" name="enable" type="bool" />
+ <param index="0" name="light" type="RID" />
+ <param index="1" name="enable" type="bool" />
<description>
If [code]true[/code], light will subtract light instead of adding light. Equivalent to [member Light3D.light_negative].
</description>
</method>
<method name="light_set_param">
<return type="void" />
- <argument index="0" name="light" type="RID" />
- <argument index="1" name="param" type="int" enum="RenderingServer.LightParam" />
- <argument index="2" name="value" type="float" />
+ <param index="0" name="light" type="RID" />
+ <param index="1" name="param" type="int" enum="RenderingServer.LightParam" />
+ <param index="2" name="value" type="float" />
<description>
Sets the specified light parameter. See [enum LightParam] for options. Equivalent to [method Light3D.set_param].
</description>
</method>
<method name="light_set_projector">
<return type="void" />
- <argument index="0" name="light" type="RID" />
- <argument index="1" name="texture" type="RID" />
+ <param index="0" name="light" type="RID" />
+ <param index="1" name="texture" type="RID" />
<description>
Not implemented in Godot 3.x.
</description>
</method>
<method name="light_set_reverse_cull_face_mode">
<return type="void" />
- <argument index="0" name="light" type="RID" />
- <argument index="1" name="enabled" type="bool" />
+ <param index="0" name="light" type="RID" />
+ <param index="1" name="enabled" type="bool" />
<description>
If [code]true[/code], 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 [method instance_geometry_set_cast_shadows_setting]. Equivalent to [member Light3D.shadow_reverse_cull_face].
</description>
</method>
<method name="light_set_shadow">
<return type="void" />
- <argument index="0" name="light" type="RID" />
- <argument index="1" name="enabled" type="bool" />
+ <param index="0" name="light" type="RID" />
+ <param index="1" name="enabled" type="bool" />
<description>
If [code]true[/code], light will cast shadows. Equivalent to [member Light3D.shadow_enabled].
</description>
@@ -1735,73 +1774,81 @@
</method>
<method name="lightmap_get_probe_capture_bsp_tree" qualifiers="const">
<return type="PackedInt32Array" />
- <argument index="0" name="lightmap" type="RID" />
+ <param index="0" name="lightmap" type="RID" />
<description>
</description>
</method>
<method name="lightmap_get_probe_capture_points" qualifiers="const">
<return type="PackedVector3Array" />
- <argument index="0" name="lightmap" type="RID" />
+ <param index="0" name="lightmap" type="RID" />
<description>
</description>
</method>
<method name="lightmap_get_probe_capture_sh" qualifiers="const">
<return type="PackedColorArray" />
- <argument index="0" name="lightmap" type="RID" />
+ <param index="0" name="lightmap" type="RID" />
<description>
</description>
</method>
<method name="lightmap_get_probe_capture_tetrahedra" qualifiers="const">
<return type="PackedInt32Array" />
- <argument index="0" name="lightmap" type="RID" />
+ <param index="0" name="lightmap" type="RID" />
+ <description>
+ </description>
+ </method>
+ <method name="lightmap_set_baked_exposure_normalization">
+ <return type="void" />
+ <param index="0" name="lightmap" type="RID" />
+ <param index="1" name="baked_exposure" type="float" />
<description>
+ Used to inform the renderer what exposure normalization value was used while baking the lightmap. This value will be used and modulated at run time to ensure that the lightmap maintains a consistent level of exposure even if the scene-wide exposure normalization is changed at run time. For more information see [method camera_attributes_set_exposure].
</description>
</method>
<method name="lightmap_set_probe_bounds">
<return type="void" />
- <argument index="0" name="lightmap" type="RID" />
- <argument index="1" name="bounds" type="AABB" />
+ <param index="0" name="lightmap" type="RID" />
+ <param index="1" name="bounds" type="AABB" />
<description>
</description>
</method>
<method name="lightmap_set_probe_capture_data">
<return type="void" />
- <argument index="0" name="lightmap" type="RID" />
- <argument index="1" name="points" type="PackedVector3Array" />
- <argument index="2" name="point_sh" type="PackedColorArray" />
- <argument index="3" name="tetrahedra" type="PackedInt32Array" />
- <argument index="4" name="bsp_tree" type="PackedInt32Array" />
+ <param index="0" name="lightmap" type="RID" />
+ <param index="1" name="points" type="PackedVector3Array" />
+ <param index="2" name="point_sh" type="PackedColorArray" />
+ <param index="3" name="tetrahedra" type="PackedInt32Array" />
+ <param index="4" name="bsp_tree" type="PackedInt32Array" />
<description>
</description>
</method>
<method name="lightmap_set_probe_capture_update_speed">
<return type="void" />
- <argument index="0" name="speed" type="float" />
+ <param index="0" name="speed" type="float" />
<description>
</description>
</method>
<method name="lightmap_set_probe_interior">
<return type="void" />
- <argument index="0" name="lightmap" type="RID" />
- <argument index="1" name="interior" type="bool" />
+ <param index="0" name="lightmap" type="RID" />
+ <param index="1" name="interior" type="bool" />
<description>
</description>
</method>
<method name="lightmap_set_textures">
<return type="void" />
- <argument index="0" name="lightmap" type="RID" />
- <argument index="1" name="light" type="RID" />
- <argument index="2" name="uses_sh" type="bool" />
+ <param index="0" name="lightmap" type="RID" />
+ <param index="1" name="light" type="RID" />
+ <param index="2" name="uses_sh" type="bool" />
<description>
</description>
</method>
<method name="make_sphere_mesh">
<return type="RID" />
- <argument index="0" name="latitudes" type="int" />
- <argument index="1" name="longitudes" type="int" />
- <argument index="2" name="radius" type="float" />
+ <param index="0" name="latitudes" type="int" />
+ <param index="1" name="longitudes" type="int" />
+ <param index="2" name="radius" type="float" />
<description>
- Returns a mesh of a sphere with the given amount of horizontal and vertical subdivisions.
+ Returns a mesh of a sphere with the given number of horizontal and vertical subdivisions.
</description>
</method>
<method name="material_create">
@@ -1813,66 +1860,66 @@
</method>
<method name="material_get_param" qualifiers="const">
<return type="Variant" />
- <argument index="0" name="material" type="RID" />
- <argument index="1" name="parameter" type="StringName" />
+ <param index="0" name="material" type="RID" />
+ <param index="1" name="parameter" type="StringName" />
<description>
Returns the value of a certain material's parameter.
</description>
</method>
<method name="material_set_next_pass">
<return type="void" />
- <argument index="0" name="material" type="RID" />
- <argument index="1" name="next_material" type="RID" />
+ <param index="0" name="material" type="RID" />
+ <param index="1" name="next_material" type="RID" />
<description>
Sets an object's next material.
</description>
</method>
<method name="material_set_param">
<return type="void" />
- <argument index="0" name="material" type="RID" />
- <argument index="1" name="parameter" type="StringName" />
- <argument index="2" name="value" type="Variant" />
+ <param index="0" name="material" type="RID" />
+ <param index="1" name="parameter" type="StringName" />
+ <param index="2" name="value" type="Variant" />
<description>
Sets a material's parameter.
</description>
</method>
<method name="material_set_render_priority">
<return type="void" />
- <argument index="0" name="material" type="RID" />
- <argument index="1" name="priority" type="int" />
+ <param index="0" name="material" type="RID" />
+ <param index="1" name="priority" type="int" />
<description>
Sets a material's render priority.
</description>
</method>
<method name="material_set_shader">
<return type="void" />
- <argument index="0" name="shader_material" type="RID" />
- <argument index="1" name="shader" type="RID" />
+ <param index="0" name="shader_material" type="RID" />
+ <param index="1" name="shader" type="RID" />
<description>
Sets a shader material's shader.
</description>
</method>
<method name="mesh_add_surface">
<return type="void" />
- <argument index="0" name="mesh" type="RID" />
- <argument index="1" name="surface" type="Dictionary" />
+ <param index="0" name="mesh" type="RID" />
+ <param index="1" name="surface" type="Dictionary" />
<description>
</description>
</method>
<method name="mesh_add_surface_from_arrays">
<return type="void" />
- <argument index="0" name="mesh" type="RID" />
- <argument index="1" name="primitive" type="int" enum="RenderingServer.PrimitiveType" />
- <argument index="2" name="arrays" type="Array" />
- <argument index="3" name="blend_shapes" type="Array" default="[]" />
- <argument index="4" name="lods" type="Dictionary" default="{}" />
- <argument index="5" name="compress_format" type="int" default="0" />
+ <param index="0" name="mesh" type="RID" />
+ <param index="1" name="primitive" type="int" enum="RenderingServer.PrimitiveType" />
+ <param index="2" name="arrays" type="Array" />
+ <param index="3" name="blend_shapes" type="Array" default="[]" />
+ <param index="4" name="lods" type="Dictionary" default="{}" />
+ <param index="5" name="compress_format" type="int" default="0" />
<description>
</description>
</method>
<method name="mesh_clear">
<return type="void" />
- <argument index="0" name="mesh" type="RID" />
+ <param index="0" name="mesh" type="RID" />
<description>
Removes all surfaces from a mesh.
</description>
@@ -1887,165 +1934,165 @@
</method>
<method name="mesh_create_from_surfaces">
<return type="RID" />
- <argument index="0" name="surfaces" type="Dictionary[]" />
- <argument index="1" name="blend_shape_count" type="int" default="0" />
+ <param index="0" name="surfaces" type="Dictionary[]" />
+ <param index="1" name="blend_shape_count" type="int" default="0" />
<description>
</description>
</method>
<method name="mesh_get_blend_shape_count" qualifiers="const">
<return type="int" />
- <argument index="0" name="mesh" type="RID" />
+ <param index="0" name="mesh" type="RID" />
<description>
Returns a mesh's blend shape count.
</description>
</method>
<method name="mesh_get_blend_shape_mode" qualifiers="const">
<return type="int" enum="RenderingServer.BlendShapeMode" />
- <argument index="0" name="mesh" type="RID" />
+ <param index="0" name="mesh" type="RID" />
<description>
Returns a mesh's blend shape mode.
</description>
</method>
<method name="mesh_get_custom_aabb" qualifiers="const">
<return type="AABB" />
- <argument index="0" name="mesh" type="RID" />
+ <param index="0" name="mesh" type="RID" />
<description>
Returns a mesh's custom aabb.
</description>
</method>
<method name="mesh_get_surface">
<return type="Dictionary" />
- <argument index="0" name="mesh" type="RID" />
- <argument index="1" name="surface" type="int" />
+ <param index="0" name="mesh" type="RID" />
+ <param index="1" name="surface" type="int" />
<description>
</description>
</method>
<method name="mesh_get_surface_count" qualifiers="const">
<return type="int" />
- <argument index="0" name="mesh" type="RID" />
+ <param index="0" name="mesh" type="RID" />
<description>
Returns a mesh's number of surfaces.
</description>
</method>
<method name="mesh_set_blend_shape_mode">
<return type="void" />
- <argument index="0" name="mesh" type="RID" />
- <argument index="1" name="mode" type="int" enum="RenderingServer.BlendShapeMode" />
+ <param index="0" name="mesh" type="RID" />
+ <param index="1" name="mode" type="int" enum="RenderingServer.BlendShapeMode" />
<description>
Sets a mesh's blend shape mode.
</description>
</method>
<method name="mesh_set_custom_aabb">
<return type="void" />
- <argument index="0" name="mesh" type="RID" />
- <argument index="1" name="aabb" type="AABB" />
+ <param index="0" name="mesh" type="RID" />
+ <param index="1" name="aabb" type="AABB" />
<description>
Sets a mesh's custom aabb.
</description>
</method>
<method name="mesh_set_shadow_mesh">
<return type="void" />
- <argument index="0" name="mesh" type="RID" />
- <argument index="1" name="shadow_mesh" type="RID" />
+ <param index="0" name="mesh" type="RID" />
+ <param index="1" name="shadow_mesh" type="RID" />
<description>
</description>
</method>
<method name="mesh_surface_get_arrays" qualifiers="const">
<return type="Array" />
- <argument index="0" name="mesh" type="RID" />
- <argument index="1" name="surface" type="int" />
+ <param index="0" name="mesh" type="RID" />
+ <param index="1" name="surface" type="int" />
<description>
Returns a mesh's surface's buffer arrays.
</description>
</method>
<method name="mesh_surface_get_blend_shape_arrays" qualifiers="const">
- <return type="Array" />
- <argument index="0" name="mesh" type="RID" />
- <argument index="1" name="surface" type="int" />
+ <return type="Array[]" />
+ <param index="0" name="mesh" type="RID" />
+ <param index="1" name="surface" type="int" />
<description>
Returns a mesh's surface's arrays for blend shapes.
</description>
</method>
<method name="mesh_surface_get_format_attribute_stride" qualifiers="const">
<return type="int" />
- <argument index="0" name="format" type="int" />
- <argument index="1" name="vertex_count" type="int" />
+ <param index="0" name="format" type="int" />
+ <param index="1" name="vertex_count" type="int" />
<description>
</description>
</method>
<method name="mesh_surface_get_format_offset" qualifiers="const">
<return type="int" />
- <argument index="0" name="format" type="int" />
- <argument index="1" name="vertex_count" type="int" />
- <argument index="2" name="array_index" type="int" />
+ <param index="0" name="format" type="int" />
+ <param index="1" name="vertex_count" type="int" />
+ <param index="2" name="array_index" type="int" />
<description>
</description>
</method>
<method name="mesh_surface_get_format_skin_stride" qualifiers="const">
<return type="int" />
- <argument index="0" name="format" type="int" />
- <argument index="1" name="vertex_count" type="int" />
+ <param index="0" name="format" type="int" />
+ <param index="1" name="vertex_count" type="int" />
<description>
</description>
</method>
<method name="mesh_surface_get_format_vertex_stride" qualifiers="const">
<return type="int" />
- <argument index="0" name="format" type="int" />
- <argument index="1" name="vertex_count" type="int" />
+ <param index="0" name="format" type="int" />
+ <param index="1" name="vertex_count" type="int" />
<description>
</description>
</method>
<method name="mesh_surface_get_material" qualifiers="const">
<return type="RID" />
- <argument index="0" name="mesh" type="RID" />
- <argument index="1" name="surface" type="int" />
+ <param index="0" name="mesh" type="RID" />
+ <param index="1" name="surface" type="int" />
<description>
Returns a mesh's surface's material.
</description>
</method>
<method name="mesh_surface_set_material">
<return type="void" />
- <argument index="0" name="mesh" type="RID" />
- <argument index="1" name="surface" type="int" />
- <argument index="2" name="material" type="RID" />
+ <param index="0" name="mesh" type="RID" />
+ <param index="1" name="surface" type="int" />
+ <param index="2" name="material" type="RID" />
<description>
Sets a mesh's surface's material.
</description>
</method>
<method name="mesh_surface_update_attribute_region">
<return type="void" />
- <argument index="0" name="mesh" type="RID" />
- <argument index="1" name="surface" type="int" />
- <argument index="2" name="offset" type="int" />
- <argument index="3" name="data" type="PackedByteArray" />
+ <param index="0" name="mesh" type="RID" />
+ <param index="1" name="surface" type="int" />
+ <param index="2" name="offset" type="int" />
+ <param index="3" name="data" type="PackedByteArray" />
<description>
</description>
</method>
<method name="mesh_surface_update_skin_region">
<return type="void" />
- <argument index="0" name="mesh" type="RID" />
- <argument index="1" name="surface" type="int" />
- <argument index="2" name="offset" type="int" />
- <argument index="3" name="data" type="PackedByteArray" />
+ <param index="0" name="mesh" type="RID" />
+ <param index="1" name="surface" type="int" />
+ <param index="2" name="offset" type="int" />
+ <param index="3" name="data" type="PackedByteArray" />
<description>
</description>
</method>
<method name="mesh_surface_update_vertex_region">
<return type="void" />
- <argument index="0" name="mesh" type="RID" />
- <argument index="1" name="surface" type="int" />
- <argument index="2" name="offset" type="int" />
- <argument index="3" name="data" type="PackedByteArray" />
+ <param index="0" name="mesh" type="RID" />
+ <param index="1" name="surface" type="int" />
+ <param index="2" name="offset" type="int" />
+ <param index="3" name="data" type="PackedByteArray" />
<description>
</description>
</method>
<method name="multimesh_allocate_data">
<return type="void" />
- <argument index="0" name="multimesh" type="RID" />
- <argument index="1" name="instances" type="int" />
- <argument index="2" name="transform_format" type="int" enum="RenderingServer.MultimeshTransformFormat" />
- <argument index="3" name="color_format" type="bool" default="false" />
- <argument index="4" name="custom_data_format" type="bool" default="false" />
+ <param index="0" name="multimesh" type="RID" />
+ <param index="1" name="instances" type="int" />
+ <param index="2" name="transform_format" type="int" enum="RenderingServer.MultimeshTransformFormat" />
+ <param index="3" name="color_format" type="bool" default="false" />
+ <param index="4" name="custom_data_format" type="bool" default="false" />
<description>
</description>
</method>
@@ -2059,125 +2106,125 @@
</method>
<method name="multimesh_get_aabb" qualifiers="const">
<return type="AABB" />
- <argument index="0" name="multimesh" type="RID" />
+ <param index="0" name="multimesh" type="RID" />
<description>
Calculates and returns the axis-aligned bounding box that encloses all instances within the multimesh.
</description>
</method>
<method name="multimesh_get_buffer" qualifiers="const">
<return type="PackedFloat32Array" />
- <argument index="0" name="multimesh" type="RID" />
+ <param index="0" name="multimesh" type="RID" />
<description>
</description>
</method>
<method name="multimesh_get_instance_count" qualifiers="const">
<return type="int" />
- <argument index="0" name="multimesh" type="RID" />
+ <param index="0" name="multimesh" type="RID" />
<description>
Returns the number of instances allocated for this multimesh.
</description>
</method>
<method name="multimesh_get_mesh" qualifiers="const">
<return type="RID" />
- <argument index="0" name="multimesh" type="RID" />
+ <param index="0" name="multimesh" type="RID" />
<description>
Returns the RID of the mesh that will be used in drawing this multimesh.
</description>
</method>
<method name="multimesh_get_visible_instances" qualifiers="const">
<return type="int" />
- <argument index="0" name="multimesh" type="RID" />
+ <param index="0" name="multimesh" type="RID" />
<description>
Returns the number of visible instances for this multimesh.
</description>
</method>
<method name="multimesh_instance_get_color" qualifiers="const">
<return type="Color" />
- <argument index="0" name="multimesh" type="RID" />
- <argument index="1" name="index" type="int" />
+ <param index="0" name="multimesh" type="RID" />
+ <param index="1" name="index" type="int" />
<description>
Returns the color by which the specified instance will be modulated.
</description>
</method>
<method name="multimesh_instance_get_custom_data" qualifiers="const">
<return type="Color" />
- <argument index="0" name="multimesh" type="RID" />
- <argument index="1" name="index" type="int" />
+ <param index="0" name="multimesh" type="RID" />
+ <param index="1" name="index" type="int" />
<description>
Returns the custom data associated with the specified instance.
</description>
</method>
<method name="multimesh_instance_get_transform" qualifiers="const">
<return type="Transform3D" />
- <argument index="0" name="multimesh" type="RID" />
- <argument index="1" name="index" type="int" />
+ <param index="0" name="multimesh" type="RID" />
+ <param index="1" name="index" type="int" />
<description>
Returns the [Transform3D] of the specified instance.
</description>
</method>
<method name="multimesh_instance_get_transform_2d" qualifiers="const">
<return type="Transform2D" />
- <argument index="0" name="multimesh" type="RID" />
- <argument index="1" name="index" type="int" />
+ <param index="0" name="multimesh" type="RID" />
+ <param index="1" name="index" type="int" />
<description>
Returns the [Transform2D] of the specified instance. For use when the multimesh is set to use 2D transforms.
</description>
</method>
<method name="multimesh_instance_set_color">
<return type="void" />
- <argument index="0" name="multimesh" type="RID" />
- <argument index="1" name="index" type="int" />
- <argument index="2" name="color" type="Color" />
+ <param index="0" name="multimesh" type="RID" />
+ <param index="1" name="index" type="int" />
+ <param index="2" name="color" type="Color" />
<description>
Sets the color by which this instance will be modulated. Equivalent to [method MultiMesh.set_instance_color].
</description>
</method>
<method name="multimesh_instance_set_custom_data">
<return type="void" />
- <argument index="0" name="multimesh" type="RID" />
- <argument index="1" name="index" type="int" />
- <argument index="2" name="custom_data" type="Color" />
+ <param index="0" name="multimesh" type="RID" />
+ <param index="1" name="index" type="int" />
+ <param index="2" name="custom_data" type="Color" />
<description>
Sets the custom data for this instance. Custom data is passed as a [Color], but is interpreted as a [code]vec4[/code] in the shader. Equivalent to [method MultiMesh.set_instance_custom_data].
</description>
</method>
<method name="multimesh_instance_set_transform">
<return type="void" />
- <argument index="0" name="multimesh" type="RID" />
- <argument index="1" name="index" type="int" />
- <argument index="2" name="transform" type="Transform3D" />
+ <param index="0" name="multimesh" type="RID" />
+ <param index="1" name="index" type="int" />
+ <param index="2" name="transform" type="Transform3D" />
<description>
Sets the [Transform3D] for this instance. Equivalent to [method MultiMesh.set_instance_transform].
</description>
</method>
<method name="multimesh_instance_set_transform_2d">
<return type="void" />
- <argument index="0" name="multimesh" type="RID" />
- <argument index="1" name="index" type="int" />
- <argument index="2" name="transform" type="Transform2D" />
+ <param index="0" name="multimesh" type="RID" />
+ <param index="1" name="index" type="int" />
+ <param index="2" name="transform" type="Transform2D" />
<description>
Sets the [Transform2D] for this instance. For use when multimesh is used in 2D. Equivalent to [method MultiMesh.set_instance_transform_2d].
</description>
</method>
<method name="multimesh_set_buffer">
<return type="void" />
- <argument index="0" name="multimesh" type="RID" />
- <argument index="1" name="buffer" type="PackedFloat32Array" />
+ <param index="0" name="multimesh" type="RID" />
+ <param index="1" name="buffer" type="PackedFloat32Array" />
<description>
</description>
</method>
<method name="multimesh_set_mesh">
<return type="void" />
- <argument index="0" name="multimesh" type="RID" />
- <argument index="1" name="mesh" type="RID" />
+ <param index="0" name="multimesh" type="RID" />
+ <param index="1" name="mesh" type="RID" />
<description>
Sets the mesh to be drawn by the multimesh. Equivalent to [member MultiMesh.mesh].
</description>
</method>
<method name="multimesh_set_visible_instances">
<return type="void" />
- <argument index="0" name="multimesh" type="RID" />
- <argument index="1" name="visible" type="int" />
+ <param index="0" name="multimesh" type="RID" />
+ <param index="1" name="visible" type="int" />
<description>
Sets the number of instances visible at a given time. If -1, all instances that have been allocated are drawn. Equivalent to [member MultiMesh.visible_instance_count].
</description>
@@ -2189,9 +2236,9 @@
</method>
<method name="occluder_set_mesh">
<return type="void" />
- <argument index="0" name="occluder" type="RID" />
- <argument index="1" name="vertices" type="PackedVector3Array" />
- <argument index="2" name="indices" type="PackedInt32Array" />
+ <param index="0" name="occluder" type="RID" />
+ <param index="1" name="vertices" type="PackedVector3Array" />
+ <param index="2" name="indices" type="PackedInt32Array" />
<description>
</description>
</method>
@@ -2210,70 +2257,70 @@
</method>
<method name="particles_collision_height_field_update">
<return type="void" />
- <argument index="0" name="particles_collision" type="RID" />
+ <param index="0" name="particles_collision" type="RID" />
<description>
</description>
</method>
<method name="particles_collision_set_attractor_attenuation">
<return type="void" />
- <argument index="0" name="particles_collision" type="RID" />
- <argument index="1" name="curve" type="float" />
+ <param index="0" name="particles_collision" type="RID" />
+ <param index="1" name="curve" type="float" />
<description>
</description>
</method>
<method name="particles_collision_set_attractor_directionality">
<return type="void" />
- <argument index="0" name="particles_collision" type="RID" />
- <argument index="1" name="amount" type="float" />
+ <param index="0" name="particles_collision" type="RID" />
+ <param index="1" name="amount" type="float" />
<description>
</description>
</method>
<method name="particles_collision_set_attractor_strength">
<return type="void" />
- <argument index="0" name="particles_collision" type="RID" />
- <argument index="1" name="setrngth" type="float" />
+ <param index="0" name="particles_collision" type="RID" />
+ <param index="1" name="setrngth" type="float" />
<description>
</description>
</method>
<method name="particles_collision_set_box_extents">
<return type="void" />
- <argument index="0" name="particles_collision" type="RID" />
- <argument index="1" name="extents" type="Vector3" />
+ <param index="0" name="particles_collision" type="RID" />
+ <param index="1" name="extents" type="Vector3" />
<description>
</description>
</method>
<method name="particles_collision_set_collision_type">
<return type="void" />
- <argument index="0" name="particles_collision" type="RID" />
- <argument index="1" name="type" type="int" enum="RenderingServer.ParticlesCollisionType" />
+ <param index="0" name="particles_collision" type="RID" />
+ <param index="1" name="type" type="int" enum="RenderingServer.ParticlesCollisionType" />
<description>
</description>
</method>
<method name="particles_collision_set_cull_mask">
<return type="void" />
- <argument index="0" name="particles_collision" type="RID" />
- <argument index="1" name="mask" type="int" />
+ <param index="0" name="particles_collision" type="RID" />
+ <param index="1" name="mask" type="int" />
<description>
</description>
</method>
<method name="particles_collision_set_field_texture">
<return type="void" />
- <argument index="0" name="particles_collision" type="RID" />
- <argument index="1" name="texture" type="RID" />
+ <param index="0" name="particles_collision" type="RID" />
+ <param index="1" name="texture" type="RID" />
<description>
</description>
</method>
<method name="particles_collision_set_height_field_resolution">
<return type="void" />
- <argument index="0" name="particles_collision" type="RID" />
- <argument index="1" name="resolution" type="int" enum="RenderingServer.ParticlesCollisionHeightfieldResolution" />
+ <param index="0" name="particles_collision" type="RID" />
+ <param index="1" name="resolution" type="int" enum="RenderingServer.ParticlesCollisionHeightfieldResolution" />
<description>
</description>
</method>
<method name="particles_collision_set_sphere_radius">
<return type="void" />
- <argument index="0" name="particles_collision" type="RID" />
- <argument index="1" name="radius" type="float" />
+ <param index="0" name="particles_collision" type="RID" />
+ <param index="1" name="radius" type="float" />
<description>
</description>
</method>
@@ -2287,180 +2334,180 @@
</method>
<method name="particles_emit">
<return type="void" />
- <argument index="0" name="particles" type="RID" />
- <argument index="1" name="transform" type="Transform3D" />
- <argument index="2" name="velocity" type="Vector3" />
- <argument index="3" name="color" type="Color" />
- <argument index="4" name="custom" type="Color" />
- <argument index="5" name="emit_flags" type="int" />
+ <param index="0" name="particles" type="RID" />
+ <param index="1" name="transform" type="Transform3D" />
+ <param index="2" name="velocity" type="Vector3" />
+ <param index="3" name="color" type="Color" />
+ <param index="4" name="custom" type="Color" />
+ <param index="5" name="emit_flags" type="int" />
<description>
</description>
</method>
<method name="particles_get_current_aabb">
<return type="AABB" />
- <argument index="0" name="particles" type="RID" />
+ <param index="0" name="particles" type="RID" />
<description>
Calculates and returns the axis-aligned bounding box that contains all the particles. Equivalent to [method GPUParticles3D.capture_aabb].
</description>
</method>
<method name="particles_get_emitting">
<return type="bool" />
- <argument index="0" name="particles" type="RID" />
+ <param index="0" name="particles" type="RID" />
<description>
Returns [code]true[/code] if particles are currently set to emitting.
</description>
</method>
<method name="particles_is_inactive">
<return type="bool" />
- <argument index="0" name="particles" type="RID" />
+ <param index="0" name="particles" type="RID" />
<description>
Returns [code]true[/code] if particles are not emitting and particles are set to inactive.
</description>
</method>
<method name="particles_request_process">
<return type="void" />
- <argument index="0" name="particles" type="RID" />
+ <param index="0" name="particles" type="RID" />
<description>
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 [method instances_cull_aabb], [method instances_cull_convex], or [method instances_cull_ray].
</description>
</method>
<method name="particles_restart">
<return type="void" />
- <argument index="0" name="particles" type="RID" />
+ <param index="0" name="particles" type="RID" />
<description>
Reset the particles on the next update. Equivalent to [method GPUParticles3D.restart].
</description>
</method>
<method name="particles_set_amount">
<return type="void" />
- <argument index="0" name="particles" type="RID" />
- <argument index="1" name="amount" type="int" />
+ <param index="0" name="particles" type="RID" />
+ <param index="1" name="amount" type="int" />
<description>
Sets the number of particles to be drawn and allocates the memory for them. Equivalent to [member GPUParticles3D.amount].
</description>
</method>
<method name="particles_set_collision_base_size">
<return type="void" />
- <argument index="0" name="particles" type="RID" />
- <argument index="1" name="size" type="float" />
+ <param index="0" name="particles" type="RID" />
+ <param index="1" name="size" type="float" />
<description>
</description>
</method>
<method name="particles_set_custom_aabb">
<return type="void" />
- <argument index="0" name="particles" type="RID" />
- <argument index="1" name="aabb" type="AABB" />
+ <param index="0" name="particles" type="RID" />
+ <param index="1" name="aabb" type="AABB" />
<description>
Sets a custom axis-aligned bounding box for the particle system. Equivalent to [member GPUParticles3D.visibility_aabb].
</description>
</method>
<method name="particles_set_draw_order">
<return type="void" />
- <argument index="0" name="particles" type="RID" />
- <argument index="1" name="order" type="int" enum="RenderingServer.ParticlesDrawOrder" />
+ <param index="0" name="particles" type="RID" />
+ <param index="1" name="order" type="int" enum="RenderingServer.ParticlesDrawOrder" />
<description>
Sets the draw order of the particles to one of the named enums from [enum ParticlesDrawOrder]. See [enum ParticlesDrawOrder] for options. Equivalent to [member GPUParticles3D.draw_order].
</description>
</method>
<method name="particles_set_draw_pass_mesh">
<return type="void" />
- <argument index="0" name="particles" type="RID" />
- <argument index="1" name="pass" type="int" />
- <argument index="2" name="mesh" type="RID" />
+ <param index="0" name="particles" type="RID" />
+ <param index="1" name="pass" type="int" />
+ <param index="2" name="mesh" type="RID" />
<description>
Sets the mesh to be used for the specified draw pass. Equivalent to [member GPUParticles3D.draw_pass_1], [member GPUParticles3D.draw_pass_2], [member GPUParticles3D.draw_pass_3], and [member GPUParticles3D.draw_pass_4].
</description>
</method>
<method name="particles_set_draw_passes">
<return type="void" />
- <argument index="0" name="particles" type="RID" />
- <argument index="1" name="count" type="int" />
+ <param index="0" name="particles" type="RID" />
+ <param index="1" name="count" type="int" />
<description>
Sets the number of draw passes to use. Equivalent to [member GPUParticles3D.draw_passes].
</description>
</method>
<method name="particles_set_emission_transform">
<return type="void" />
- <argument index="0" name="particles" type="RID" />
- <argument index="1" name="transform" type="Transform3D" />
+ <param index="0" name="particles" type="RID" />
+ <param index="1" name="transform" type="Transform3D" />
<description>
Sets the [Transform3D] that will be used by the particles when they first emit.
</description>
</method>
<method name="particles_set_emitting">
<return type="void" />
- <argument index="0" name="particles" type="RID" />
- <argument index="1" name="emitting" type="bool" />
+ <param index="0" name="particles" type="RID" />
+ <param index="1" name="emitting" type="bool" />
<description>
If [code]true[/code], particles will emit over time. Setting to false does not reset the particles, but only stops their emission. Equivalent to [member GPUParticles3D.emitting].
</description>
</method>
<method name="particles_set_explosiveness_ratio">
<return type="void" />
- <argument index="0" name="particles" type="RID" />
- <argument index="1" name="ratio" type="float" />
+ <param index="0" name="particles" type="RID" />
+ <param index="1" name="ratio" type="float" />
<description>
Sets the explosiveness ratio. Equivalent to [member GPUParticles3D.explosiveness].
</description>
</method>
<method name="particles_set_fixed_fps">
<return type="void" />
- <argument index="0" name="particles" type="RID" />
- <argument index="1" name="fps" type="int" />
+ <param index="0" name="particles" type="RID" />
+ <param index="1" name="fps" type="int" />
<description>
Sets the frame rate that the particle system rendering will be fixed to. Equivalent to [member GPUParticles3D.fixed_fps].
</description>
</method>
<method name="particles_set_fractional_delta">
<return type="void" />
- <argument index="0" name="particles" type="RID" />
- <argument index="1" name="enable" type="bool" />
+ <param index="0" name="particles" type="RID" />
+ <param index="1" name="enable" type="bool" />
<description>
If [code]true[/code], uses fractional delta which smooths the movement of the particles. Equivalent to [member GPUParticles3D.fract_delta].
</description>
</method>
<method name="particles_set_interpolate">
<return type="void" />
- <argument index="0" name="particles" type="RID" />
- <argument index="1" name="enable" type="bool" />
+ <param index="0" name="particles" type="RID" />
+ <param index="1" name="enable" type="bool" />
<description>
</description>
</method>
<method name="particles_set_lifetime">
<return type="void" />
- <argument index="0" name="particles" type="RID" />
- <argument index="1" name="lifetime" type="float" />
+ <param index="0" name="particles" type="RID" />
+ <param index="1" name="lifetime" type="float" />
<description>
Sets the lifetime of each particle in the system. Equivalent to [member GPUParticles3D.lifetime].
</description>
</method>
<method name="particles_set_mode">
<return type="void" />
- <argument index="0" name="particles" type="RID" />
- <argument index="1" name="mode" type="int" enum="RenderingServer.ParticlesMode" />
+ <param index="0" name="particles" type="RID" />
+ <param index="1" name="mode" type="int" enum="RenderingServer.ParticlesMode" />
<description>
</description>
</method>
<method name="particles_set_one_shot">
<return type="void" />
- <argument index="0" name="particles" type="RID" />
- <argument index="1" name="one_shot" type="bool" />
+ <param index="0" name="particles" type="RID" />
+ <param index="1" name="one_shot" type="bool" />
<description>
If [code]true[/code], particles will emit once and then stop. Equivalent to [member GPUParticles3D.one_shot].
</description>
</method>
<method name="particles_set_pre_process_time">
<return type="void" />
- <argument index="0" name="particles" type="RID" />
- <argument index="1" name="time" type="float" />
+ <param index="0" name="particles" type="RID" />
+ <param index="1" name="time" type="float" />
<description>
Sets the preprocess time for the particles' animation. This lets you delay starting an animation until after the particles have begun emitting. Equivalent to [member GPUParticles3D.preprocess].
</description>
</method>
<method name="particles_set_process_material">
<return type="void" />
- <argument index="0" name="particles" type="RID" />
- <argument index="1" name="material" type="RID" />
+ <param index="0" name="particles" type="RID" />
+ <param index="1" name="material" type="RID" />
<description>
Sets the material for processing the particles.
[b]Note:[/b] This is not the material used to draw the materials. Equivalent to [member GPUParticles3D.process_material].
@@ -2468,60 +2515,60 @@
</method>
<method name="particles_set_randomness_ratio">
<return type="void" />
- <argument index="0" name="particles" type="RID" />
- <argument index="1" name="ratio" type="float" />
+ <param index="0" name="particles" type="RID" />
+ <param index="1" name="ratio" type="float" />
<description>
Sets the emission randomness ratio. This randomizes the emission of particles within their phase. Equivalent to [member GPUParticles3D.randomness].
</description>
</method>
<method name="particles_set_speed_scale">
<return type="void" />
- <argument index="0" name="particles" type="RID" />
- <argument index="1" name="scale" type="float" />
+ <param index="0" name="particles" type="RID" />
+ <param index="1" name="scale" type="float" />
<description>
Sets the speed scale of the particle system. Equivalent to [member GPUParticles3D.speed_scale].
</description>
</method>
<method name="particles_set_subemitter">
<return type="void" />
- <argument index="0" name="particles" type="RID" />
- <argument index="1" name="subemitter_particles" type="RID" />
+ <param index="0" name="particles" type="RID" />
+ <param index="1" name="subemitter_particles" type="RID" />
<description>
</description>
</method>
<method name="particles_set_trail_bind_poses">
<return type="void" />
- <argument index="0" name="particles" type="RID" />
- <argument index="1" name="bind_poses" type="Transform3D[]" />
+ <param index="0" name="particles" type="RID" />
+ <param index="1" name="bind_poses" type="Transform3D[]" />
<description>
</description>
</method>
<method name="particles_set_trails">
<return type="void" />
- <argument index="0" name="particles" type="RID" />
- <argument index="1" name="enable" type="bool" />
- <argument index="2" name="length_sec" type="float" />
+ <param index="0" name="particles" type="RID" />
+ <param index="1" name="enable" type="bool" />
+ <param index="2" name="length_sec" type="float" />
<description>
</description>
</method>
<method name="particles_set_transform_align">
<return type="void" />
- <argument index="0" name="particles" type="RID" />
- <argument index="1" name="align" type="int" enum="RenderingServer.ParticlesTransformAlign" />
+ <param index="0" name="particles" type="RID" />
+ <param index="1" name="align" type="int" enum="RenderingServer.ParticlesTransformAlign" />
<description>
</description>
</method>
<method name="particles_set_use_local_coordinates">
<return type="void" />
- <argument index="0" name="particles" type="RID" />
- <argument index="1" name="enable" type="bool" />
+ <param index="0" name="particles" type="RID" />
+ <param index="1" name="enable" type="bool" />
<description>
If [code]true[/code], particles use local coordinates. If [code]false[/code] they use global coordinates. Equivalent to [member GPUParticles3D.local_coords].
</description>
</method>
<method name="positional_soft_shadow_filter_set_quality">
<return type="void" />
- <argument index="0" name="quality" type="int" enum="RenderingServer.ShadowQuality" />
+ <param index="0" name="quality" type="int" enum="RenderingServer.ShadowQuality" />
<description>
</description>
</method>
@@ -2535,114 +2582,114 @@
</method>
<method name="reflection_probe_set_ambient_color">
<return type="void" />
- <argument index="0" name="probe" type="RID" />
- <argument index="1" name="color" type="Color" />
+ <param index="0" name="probe" type="RID" />
+ <param index="1" name="color" type="Color" />
<description>
</description>
</method>
<method name="reflection_probe_set_ambient_energy">
<return type="void" />
- <argument index="0" name="probe" type="RID" />
- <argument index="1" name="energy" type="float" />
+ <param index="0" name="probe" type="RID" />
+ <param index="1" name="energy" type="float" />
<description>
</description>
</method>
<method name="reflection_probe_set_ambient_mode">
<return type="void" />
- <argument index="0" name="probe" type="RID" />
- <argument index="1" name="mode" type="int" enum="RenderingServer.ReflectionProbeAmbientMode" />
+ <param index="0" name="probe" type="RID" />
+ <param index="1" name="mode" type="int" enum="RenderingServer.ReflectionProbeAmbientMode" />
<description>
</description>
</method>
<method name="reflection_probe_set_as_interior">
<return type="void" />
- <argument index="0" name="probe" type="RID" />
- <argument index="1" name="enable" type="bool" />
+ <param index="0" name="probe" type="RID" />
+ <param index="1" name="enable" type="bool" />
<description>
If [code]true[/code], reflections will ignore sky contribution. Equivalent to [member ReflectionProbe.interior].
</description>
</method>
<method name="reflection_probe_set_cull_mask">
<return type="void" />
- <argument index="0" name="probe" type="RID" />
- <argument index="1" name="layers" type="int" />
+ <param index="0" name="probe" type="RID" />
+ <param index="1" name="layers" type="int" />
<description>
Sets the render cull mask for this reflection probe. Only instances with a matching cull mask will be rendered by this probe. Equivalent to [member ReflectionProbe.cull_mask].
</description>
</method>
<method name="reflection_probe_set_enable_box_projection">
<return type="void" />
- <argument index="0" name="probe" type="RID" />
- <argument index="1" name="enable" type="bool" />
+ <param index="0" name="probe" type="RID" />
+ <param index="1" name="enable" type="bool" />
<description>
If [code]true[/code], uses box projection. This can make reflections look more correct in certain situations. Equivalent to [member ReflectionProbe.box_projection].
</description>
</method>
<method name="reflection_probe_set_enable_shadows">
<return type="void" />
- <argument index="0" name="probe" type="RID" />
- <argument index="1" name="enable" type="bool" />
+ <param index="0" name="probe" type="RID" />
+ <param index="1" name="enable" type="bool" />
<description>
If [code]true[/code], computes shadows in the reflection probe. This makes the reflection much slower to compute. Equivalent to [member ReflectionProbe.enable_shadows].
</description>
</method>
<method name="reflection_probe_set_extents">
<return type="void" />
- <argument index="0" name="probe" type="RID" />
- <argument index="1" name="extents" type="Vector3" />
+ <param index="0" name="probe" type="RID" />
+ <param index="1" name="extents" type="Vector3" />
<description>
Sets the size of the area that the reflection probe will capture. Equivalent to [member ReflectionProbe.extents].
</description>
</method>
<method name="reflection_probe_set_intensity">
<return type="void" />
- <argument index="0" name="probe" type="RID" />
- <argument index="1" name="intensity" type="float" />
+ <param index="0" name="probe" type="RID" />
+ <param index="1" name="intensity" type="float" />
<description>
Sets the intensity of the reflection probe. Intensity modulates the strength of the reflection. Equivalent to [member ReflectionProbe.intensity].
</description>
</method>
<method name="reflection_probe_set_max_distance">
<return type="void" />
- <argument index="0" name="probe" type="RID" />
- <argument index="1" name="distance" type="float" />
+ <param index="0" name="probe" type="RID" />
+ <param index="1" name="distance" type="float" />
<description>
Sets the max distance away from the probe an object can be before it is culled. Equivalent to [member ReflectionProbe.max_distance].
</description>
</method>
<method name="reflection_probe_set_mesh_lod_threshold">
<return type="void" />
- <argument index="0" name="probe" type="RID" />
- <argument index="1" name="pixels" type="float" />
+ <param index="0" name="probe" type="RID" />
+ <param index="1" name="pixels" type="float" />
<description>
</description>
</method>
<method name="reflection_probe_set_origin_offset">
<return type="void" />
- <argument index="0" name="probe" type="RID" />
- <argument index="1" name="offset" type="Vector3" />
+ <param index="0" name="probe" type="RID" />
+ <param index="1" name="offset" type="Vector3" />
<description>
Sets the origin offset to be used when this reflection probe is in box project mode. Equivalent to [member ReflectionProbe.origin_offset].
</description>
</method>
<method name="reflection_probe_set_resolution">
<return type="void" />
- <argument index="0" name="probe" type="RID" />
- <argument index="1" name="resolution" type="int" />
+ <param index="0" name="probe" type="RID" />
+ <param index="1" name="resolution" type="int" />
<description>
</description>
</method>
<method name="reflection_probe_set_update_mode">
<return type="void" />
- <argument index="0" name="probe" type="RID" />
- <argument index="1" name="mode" type="int" enum="RenderingServer.ReflectionProbeUpdateMode" />
+ <param index="0" name="probe" type="RID" />
+ <param index="1" name="mode" type="int" enum="RenderingServer.ReflectionProbeUpdateMode" />
<description>
Sets how often the reflection probe updates. Can either be once or every frame. See [enum ReflectionProbeUpdateMode] for options.
</description>
</method>
<method name="request_frame_drawn_callback">
<return type="void" />
- <argument index="0" name="callable" type="Callable" />
+ <param index="0" name="callable" type="Callable" />
<description>
Schedules a callback to the given callable after a frame has been drawn.
</description>
@@ -2655,57 +2702,57 @@
The scenario is the 3D world that all the visual instances exist in.
</description>
</method>
- <method name="scenario_set_camera_effects">
+ <method name="scenario_set_camera_attributes">
<return type="void" />
- <argument index="0" name="scenario" type="RID" />
- <argument index="1" name="effects" type="RID" />
+ <param index="0" name="scenario" type="RID" />
+ <param index="1" name="effects" type="RID" />
<description>
</description>
</method>
<method name="scenario_set_environment">
<return type="void" />
- <argument index="0" name="scenario" type="RID" />
- <argument index="1" name="environment" type="RID" />
+ <param index="0" name="scenario" type="RID" />
+ <param index="1" name="environment" type="RID" />
<description>
Sets the environment that will be used with this scenario.
</description>
</method>
<method name="scenario_set_fallback_environment">
<return type="void" />
- <argument index="0" name="scenario" type="RID" />
- <argument index="1" name="environment" type="RID" />
+ <param index="0" name="scenario" type="RID" />
+ <param index="1" name="environment" type="RID" />
<description>
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.
</description>
</method>
<method name="screen_space_roughness_limiter_set_active">
<return type="void" />
- <argument index="0" name="enable" type="bool" />
- <argument index="1" name="amount" type="float" />
- <argument index="2" name="limit" type="float" />
+ <param index="0" name="enable" type="bool" />
+ <param index="1" name="amount" type="float" />
+ <param index="2" name="limit" type="float" />
<description>
</description>
</method>
<method name="set_boot_image">
<return type="void" />
- <argument index="0" name="image" type="Image" />
- <argument index="1" name="color" type="Color" />
- <argument index="2" name="scale" type="bool" />
- <argument index="3" name="use_filter" type="bool" default="true" />
+ <param index="0" name="image" type="Image" />
+ <param index="1" name="color" type="Color" />
+ <param index="2" name="scale" type="bool" />
+ <param index="3" name="use_filter" type="bool" default="true" />
<description>
- Sets a boot image. The color defines the background color. If [code]scale[/code] is [code]true[/code], the image will be scaled to fit the screen size. If [code]use_filter[/code] is [code]true[/code], the image will be scaled with linear interpolation. If [code]use_filter[/code] is [code]false[/code], the image will be scaled with nearest-neighbor interpolation.
+ Sets a boot image. The color defines the background color. If [param scale] is [code]true[/code], the image will be scaled to fit the screen size. If [param use_filter] is [code]true[/code], the image will be scaled with linear interpolation. If [param use_filter] is [code]false[/code], the image will be scaled with nearest-neighbor interpolation.
</description>
</method>
<method name="set_debug_generate_wireframes">
<return type="void" />
- <argument index="0" name="generate" type="bool" />
+ <param index="0" name="generate" type="bool" />
<description>
If [code]true[/code], the engine will generate wireframes for use with the wireframe debug mode.
</description>
</method>
<method name="set_default_clear_color">
<return type="void" />
- <argument index="0" name="color" type="Color" />
+ <param index="0" name="color" type="Color" />
<description>
Sets the default clear color which is used when a specific clear color has not been selected.
</description>
@@ -2719,98 +2766,91 @@
</method>
<method name="shader_get_code" qualifiers="const">
<return type="String" />
- <argument index="0" name="shader" type="RID" />
+ <param index="0" name="shader" type="RID" />
<description>
Returns a shader's code.
</description>
</method>
- <method name="shader_get_default_texture_param" qualifiers="const">
+ <method name="shader_get_default_texture_parameter" qualifiers="const">
<return type="RID" />
- <argument index="0" name="shader" type="RID" />
- <argument index="1" name="param" type="StringName" />
- <argument index="2" name="index" type="int" default="0" />
+ <param index="0" name="shader" type="RID" />
+ <param index="1" name="name" type="StringName" />
+ <param index="2" name="index" type="int" default="0" />
<description>
Returns a default texture from a shader searched by name.
- [b]Note:[/b] If the sampler array is used use [code]index[/code] to access the specified texture.
+ [b]Note:[/b] If the sampler array is used use [param index] to access the specified texture.
</description>
</method>
- <method name="shader_get_param_default" qualifiers="const">
+ <method name="shader_get_parameter_default" qualifiers="const">
<return type="Variant" />
- <argument index="0" name="shader" type="RID" />
- <argument index="1" name="param" type="StringName" />
+ <param index="0" name="shader" type="RID" />
+ <param index="1" name="name" type="StringName" />
<description>
</description>
</method>
- <method name="shader_get_param_list" qualifiers="const">
- <return type="Dictionary[]" />
- <argument index="0" name="shader" type="RID" />
- <description>
- Returns the parameters of a shader.
- </description>
- </method>
<method name="shader_set_code">
<return type="void" />
- <argument index="0" name="shader" type="RID" />
- <argument index="1" name="code" type="String" />
+ <param index="0" name="shader" type="RID" />
+ <param index="1" name="code" type="String" />
<description>
</description>
</method>
- <method name="shader_set_default_texture_param">
+ <method name="shader_set_default_texture_parameter">
<return type="void" />
- <argument index="0" name="shader" type="RID" />
- <argument index="1" name="param" type="StringName" />
- <argument index="2" name="texture" type="RID" />
- <argument index="3" name="index" type="int" default="0" />
+ <param index="0" name="shader" type="RID" />
+ <param index="1" name="name" type="StringName" />
+ <param index="2" name="texture" type="RID" />
+ <param index="3" name="index" type="int" default="0" />
<description>
Sets a shader's default texture. Overwrites the texture given by name.
- [b]Note:[/b] If the sampler array is used use [code]index[/code] to access the specified texture.
+ [b]Note:[/b] If the sampler array is used use [param index] to access the specified texture.
</description>
</method>
<method name="shader_set_path_hint">
<return type="void" />
- <argument index="0" name="shader" type="RID" />
- <argument index="1" name="path" type="String" />
+ <param index="0" name="shader" type="RID" />
+ <param index="1" name="path" type="String" />
<description>
</description>
</method>
<method name="skeleton_allocate_data">
<return type="void" />
- <argument index="0" name="skeleton" type="RID" />
- <argument index="1" name="bones" type="int" />
- <argument index="2" name="is_2d_skeleton" type="bool" default="false" />
+ <param index="0" name="skeleton" type="RID" />
+ <param index="1" name="bones" type="int" />
+ <param index="2" name="is_2d_skeleton" type="bool" default="false" />
<description>
</description>
</method>
<method name="skeleton_bone_get_transform" qualifiers="const">
<return type="Transform3D" />
- <argument index="0" name="skeleton" type="RID" />
- <argument index="1" name="bone" type="int" />
+ <param index="0" name="skeleton" type="RID" />
+ <param index="1" name="bone" type="int" />
<description>
Returns the [Transform3D] set for a specific bone of this skeleton.
</description>
</method>
<method name="skeleton_bone_get_transform_2d" qualifiers="const">
<return type="Transform2D" />
- <argument index="0" name="skeleton" type="RID" />
- <argument index="1" name="bone" type="int" />
+ <param index="0" name="skeleton" type="RID" />
+ <param index="1" name="bone" type="int" />
<description>
Returns the [Transform2D] set for a specific bone of this skeleton.
</description>
</method>
<method name="skeleton_bone_set_transform">
<return type="void" />
- <argument index="0" name="skeleton" type="RID" />
- <argument index="1" name="bone" type="int" />
- <argument index="2" name="transform" type="Transform3D" />
+ <param index="0" name="skeleton" type="RID" />
+ <param index="1" name="bone" type="int" />
+ <param index="2" name="transform" type="Transform3D" />
<description>
Sets the [Transform3D] for a specific bone of this skeleton.
</description>
</method>
<method name="skeleton_bone_set_transform_2d">
<return type="void" />
- <argument index="0" name="skeleton" type="RID" />
- <argument index="1" name="bone" type="int" />
- <argument index="2" name="transform" type="Transform2D" />
+ <param index="0" name="skeleton" type="RID" />
+ <param index="1" name="bone" type="int" />
+ <param index="2" name="transform" type="Transform2D" />
<description>
Sets the [Transform2D] for a specific bone of this skeleton.
</description>
@@ -2824,24 +2864,24 @@
</method>
<method name="skeleton_get_bone_count" qualifiers="const">
<return type="int" />
- <argument index="0" name="skeleton" type="RID" />
+ <param index="0" name="skeleton" type="RID" />
<description>
Returns the number of bones allocated for this skeleton.
</description>
</method>
<method name="skeleton_set_base_transform_2d">
<return type="void" />
- <argument index="0" name="skeleton" type="RID" />
- <argument index="1" name="base_transform" type="Transform2D" />
+ <param index="0" name="skeleton" type="RID" />
+ <param index="1" name="base_transform" type="Transform2D" />
<description>
</description>
</method>
<method name="sky_bake_panorama">
<return type="Image" />
- <argument index="0" name="sky" type="RID" />
- <argument index="1" name="energy" type="float" />
- <argument index="2" name="bake_irradiance" type="bool" />
- <argument index="3" name="size" type="Vector2i" />
+ <param index="0" name="sky" type="RID" />
+ <param index="1" name="energy" type="float" />
+ <param index="2" name="bake_irradiance" type="bool" />
+ <param index="3" name="size" type="Vector2i" />
<description>
</description>
</method>
@@ -2854,23 +2894,23 @@
</method>
<method name="sky_set_material">
<return type="void" />
- <argument index="0" name="sky" type="RID" />
- <argument index="1" name="material" type="RID" />
+ <param index="0" name="sky" type="RID" />
+ <param index="1" name="material" type="RID" />
<description>
Sets the material that the sky uses to render the background and reflection maps.
</description>
</method>
<method name="sky_set_mode">
<return type="void" />
- <argument index="0" name="sky" type="RID" />
- <argument index="1" name="mode" type="int" enum="RenderingServer.SkyMode" />
+ <param index="0" name="sky" type="RID" />
+ <param index="1" name="mode" type="int" enum="RenderingServer.SkyMode" />
<description>
</description>
</method>
<method name="sky_set_radiance_size">
<return type="void" />
- <argument index="0" name="sky" type="RID" />
- <argument index="1" name="radiance_size" type="int" />
+ <param index="0" name="sky" type="RID" />
+ <param index="1" name="radiance_size" type="int" />
<description>
</description>
</method>
@@ -2884,46 +2924,46 @@
</method>
<method name="sub_surface_scattering_set_quality">
<return type="void" />
- <argument index="0" name="quality" type="int" enum="RenderingServer.SubSurfaceScatteringQuality" />
+ <param index="0" name="quality" type="int" enum="RenderingServer.SubSurfaceScatteringQuality" />
<description>
</description>
</method>
<method name="sub_surface_scattering_set_scale">
<return type="void" />
- <argument index="0" name="scale" type="float" />
- <argument index="1" name="depth_scale" type="float" />
+ <param index="0" name="scale" type="float" />
+ <param index="1" name="depth_scale" type="float" />
<description>
</description>
</method>
<method name="texture_2d_create">
<return type="RID" />
- <argument index="0" name="image" type="Image" />
+ <param index="0" name="image" type="Image" />
<description>
</description>
</method>
<method name="texture_2d_get" qualifiers="const">
<return type="Image" />
- <argument index="0" name="texture" type="RID" />
+ <param index="0" name="texture" type="RID" />
<description>
</description>
</method>
<method name="texture_2d_layer_get" qualifiers="const">
<return type="Image" />
- <argument index="0" name="texture" type="RID" />
- <argument index="1" name="layer" type="int" />
+ <param index="0" name="texture" type="RID" />
+ <param index="1" name="layer" type="int" />
<description>
</description>
</method>
<method name="texture_2d_layered_create">
<return type="RID" />
- <argument index="0" name="layers" type="Image[]" />
- <argument index="1" name="layered_type" type="int" enum="RenderingServer.TextureLayeredType" />
+ <param index="0" name="layers" type="Image[]" />
+ <param index="1" name="layered_type" type="int" enum="RenderingServer.TextureLayeredType" />
<description>
</description>
</method>
<method name="texture_2d_layered_placeholder_create">
<return type="RID" />
- <argument index="0" name="layered_type" type="int" enum="RenderingServer.TextureLayeredType" />
+ <param index="0" name="layered_type" type="int" enum="RenderingServer.TextureLayeredType" />
<description>
</description>
</method>
@@ -2934,26 +2974,26 @@
</method>
<method name="texture_2d_update">
<return type="void" />
- <argument index="0" name="texture" type="RID" />
- <argument index="1" name="image" type="Image" />
- <argument index="2" name="layer" type="int" />
+ <param index="0" name="texture" type="RID" />
+ <param index="1" name="image" type="Image" />
+ <param index="2" name="layer" type="int" />
<description>
</description>
</method>
<method name="texture_3d_create">
<return type="RID" />
- <argument index="0" name="format" type="int" enum="Image.Format" />
- <argument index="1" name="width" type="int" />
- <argument index="2" name="height" type="int" />
- <argument index="3" name="depth" type="int" />
- <argument index="4" name="mipmaps" type="bool" />
- <argument index="5" name="data" type="Image[]" />
+ <param index="0" name="format" type="int" enum="Image.Format" />
+ <param index="1" name="width" type="int" />
+ <param index="2" name="height" type="int" />
+ <param index="3" name="depth" type="int" />
+ <param index="4" name="mipmaps" type="bool" />
+ <param index="5" name="data" type="Image[]" />
<description>
</description>
</method>
<method name="texture_3d_get" qualifiers="const">
<return type="Image[]" />
- <argument index="0" name="texture" type="RID" />
+ <param index="0" name="texture" type="RID" />
<description>
</description>
</method>
@@ -2964,82 +3004,82 @@
</method>
<method name="texture_3d_update">
<return type="void" />
- <argument index="0" name="texture" type="RID" />
- <argument index="1" name="data" type="Image[]" />
+ <param index="0" name="texture" type="RID" />
+ <param index="1" name="data" type="Image[]" />
<description>
</description>
</method>
<method name="texture_get_path" qualifiers="const">
<return type="String" />
- <argument index="0" name="texture" type="RID" />
+ <param index="0" name="texture" type="RID" />
<description>
</description>
</method>
<method name="texture_proxy_create">
<return type="RID" />
- <argument index="0" name="base" type="RID" />
+ <param index="0" name="base" type="RID" />
<description>
</description>
</method>
<method name="texture_proxy_update">
<return type="void" />
- <argument index="0" name="texture" type="RID" />
- <argument index="1" name="proxy_to" type="RID" />
+ <param index="0" name="texture" type="RID" />
+ <param index="1" name="proxy_to" type="RID" />
<description>
</description>
</method>
<method name="texture_replace">
<return type="void" />
- <argument index="0" name="texture" type="RID" />
- <argument index="1" name="by_texture" type="RID" />
+ <param index="0" name="texture" type="RID" />
+ <param index="1" name="by_texture" type="RID" />
<description>
</description>
</method>
<method name="texture_set_force_redraw_if_visible">
<return type="void" />
- <argument index="0" name="texture" type="RID" />
- <argument index="1" name="enable" type="bool" />
+ <param index="0" name="texture" type="RID" />
+ <param index="1" name="enable" type="bool" />
<description>
</description>
</method>
<method name="texture_set_path">
<return type="void" />
- <argument index="0" name="texture" type="RID" />
- <argument index="1" name="path" type="String" />
+ <param index="0" name="texture" type="RID" />
+ <param index="1" name="path" type="String" />
<description>
</description>
</method>
<method name="texture_set_size_override">
<return type="void" />
- <argument index="0" name="texture" type="RID" />
- <argument index="1" name="width" type="int" />
- <argument index="2" name="height" type="int" />
+ <param index="0" name="texture" type="RID" />
+ <param index="1" name="width" type="int" />
+ <param index="2" name="height" type="int" />
<description>
</description>
</method>
<method name="viewport_attach_camera">
<return type="void" />
- <argument index="0" name="viewport" type="RID" />
- <argument index="1" name="camera" type="RID" />
+ <param index="0" name="viewport" type="RID" />
+ <param index="1" name="camera" type="RID" />
<description>
Sets a viewport's camera.
</description>
</method>
<method name="viewport_attach_canvas">
<return type="void" />
- <argument index="0" name="viewport" type="RID" />
- <argument index="1" name="canvas" type="RID" />
+ <param index="0" name="viewport" type="RID" />
+ <param index="1" name="canvas" type="RID" />
<description>
Sets a viewport's canvas.
</description>
</method>
<method name="viewport_attach_to_screen">
<return type="void" />
- <argument index="0" name="viewport" type="RID" />
- <argument index="1" name="rect" type="Rect2" default="Rect2(0, 0, 0, 0)" />
- <argument index="2" name="screen" type="int" default="0" />
+ <param index="0" name="viewport" type="RID" />
+ <param index="1" name="rect" type="Rect2" default="Rect2(0, 0, 0, 0)" />
+ <param index="2" name="screen" type="int" default="0" />
<description>
- Copies the viewport to a region of the screen specified by [code]rect[/code]. If [method viewport_set_render_direct_to_screen] is [code]true[/code], then the viewport does not use a framebuffer and the contents of the viewport are rendered directly to screen. However, note that the root viewport is drawn last, therefore it will draw over the screen. Accordingly, you must set the root viewport to an area that does not cover the area that you have attached this viewport to.
+ Copies the viewport to a region of the screen specified by [param rect]. If [method viewport_set_render_direct_to_screen] is [code]true[/code], then the viewport does not use a framebuffer and the contents of the viewport are rendered directly to screen. However, note that the root viewport is drawn last, therefore it will draw over the screen. Accordingly, you must set the root viewport to an area that does not cover the area that you have attached this viewport to.
For example, you can set the root viewport to not render at all with the following code:
FIXME: The method seems to be non-existent.
[codeblocks]
@@ -3061,193 +3101,193 @@
</method>
<method name="viewport_get_measured_render_time_cpu" qualifiers="const">
<return type="float" />
- <argument index="0" name="viewport" type="RID" />
+ <param index="0" name="viewport" type="RID" />
<description>
</description>
</method>
<method name="viewport_get_measured_render_time_gpu" qualifiers="const">
<return type="float" />
- <argument index="0" name="viewport" type="RID" />
+ <param index="0" name="viewport" type="RID" />
<description>
</description>
</method>
<method name="viewport_get_render_info">
<return type="int" />
- <argument index="0" name="viewport" type="RID" />
- <argument index="1" name="type" type="int" enum="RenderingServer.ViewportRenderInfoType" />
- <argument index="2" name="info" type="int" enum="RenderingServer.ViewportRenderInfo" />
+ <param index="0" name="viewport" type="RID" />
+ <param index="1" name="type" type="int" enum="RenderingServer.ViewportRenderInfoType" />
+ <param index="2" name="info" type="int" enum="RenderingServer.ViewportRenderInfo" />
<description>
</description>
</method>
<method name="viewport_get_texture" qualifiers="const">
<return type="RID" />
- <argument index="0" name="viewport" type="RID" />
+ <param index="0" name="viewport" type="RID" />
<description>
Returns the viewport's last rendered frame.
</description>
</method>
<method name="viewport_remove_canvas">
<return type="void" />
- <argument index="0" name="viewport" type="RID" />
- <argument index="1" name="canvas" type="RID" />
+ <param index="0" name="viewport" type="RID" />
+ <param index="1" name="canvas" type="RID" />
<description>
Detaches a viewport from a canvas and vice versa.
</description>
</method>
<method name="viewport_set_active">
<return type="void" />
- <argument index="0" name="viewport" type="RID" />
- <argument index="1" name="active" type="bool" />
+ <param index="0" name="viewport" type="RID" />
+ <param index="1" name="active" type="bool" />
<description>
If [code]true[/code], sets the viewport active, else sets it inactive.
</description>
</method>
<method name="viewport_set_canvas_stacking">
<return type="void" />
- <argument index="0" name="viewport" type="RID" />
- <argument index="1" name="canvas" type="RID" />
- <argument index="2" name="layer" type="int" />
- <argument index="3" name="sublayer" type="int" />
+ <param index="0" name="viewport" type="RID" />
+ <param index="1" name="canvas" type="RID" />
+ <param index="2" name="layer" type="int" />
+ <param index="3" name="sublayer" type="int" />
<description>
Sets the stacking order for a viewport's canvas.
- [code]layer[/code] is the actual canvas layer, while [code]sublayer[/code] specifies the stacking order of the canvas among those in the same layer.
+ [param layer] is the actual canvas layer, while [param sublayer] specifies the stacking order of the canvas among those in the same layer.
</description>
</method>
<method name="viewport_set_canvas_transform">
<return type="void" />
- <argument index="0" name="viewport" type="RID" />
- <argument index="1" name="canvas" type="RID" />
- <argument index="2" name="offset" type="Transform2D" />
+ <param index="0" name="viewport" type="RID" />
+ <param index="1" name="canvas" type="RID" />
+ <param index="2" name="offset" type="Transform2D" />
<description>
Sets the transformation of a viewport's canvas.
</description>
</method>
<method name="viewport_set_clear_mode">
<return type="void" />
- <argument index="0" name="viewport" type="RID" />
- <argument index="1" name="clear_mode" type="int" enum="RenderingServer.ViewportClearMode" />
+ <param index="0" name="viewport" type="RID" />
+ <param index="1" name="clear_mode" type="int" enum="RenderingServer.ViewportClearMode" />
<description>
Sets the clear mode of a viewport. See [enum ViewportClearMode] for options.
</description>
</method>
<method name="viewport_set_debug_draw">
<return type="void" />
- <argument index="0" name="viewport" type="RID" />
- <argument index="1" name="draw" type="int" enum="RenderingServer.ViewportDebugDraw" />
+ <param index="0" name="viewport" type="RID" />
+ <param index="1" name="draw" type="int" enum="RenderingServer.ViewportDebugDraw" />
<description>
Sets the debug draw mode of a viewport. See [enum ViewportDebugDraw] for options.
</description>
</method>
<method name="viewport_set_default_canvas_item_texture_filter">
<return type="void" />
- <argument index="0" name="viewport" type="RID" />
- <argument index="1" name="filter" type="int" enum="RenderingServer.CanvasItemTextureFilter" />
+ <param index="0" name="viewport" type="RID" />
+ <param index="1" name="filter" type="int" enum="RenderingServer.CanvasItemTextureFilter" />
<description>
</description>
</method>
<method name="viewport_set_default_canvas_item_texture_repeat">
<return type="void" />
- <argument index="0" name="viewport" type="RID" />
- <argument index="1" name="repeat" type="int" enum="RenderingServer.CanvasItemTextureRepeat" />
+ <param index="0" name="viewport" type="RID" />
+ <param index="1" name="repeat" type="int" enum="RenderingServer.CanvasItemTextureRepeat" />
<description>
</description>
</method>
<method name="viewport_set_disable_2d">
<return type="void" />
- <argument index="0" name="viewport" type="RID" />
- <argument index="1" name="disable" type="bool" />
+ <param index="0" name="viewport" type="RID" />
+ <param index="1" name="disable" type="bool" />
<description>
If [code]true[/code], the viewport's canvas is not rendered.
</description>
</method>
<method name="viewport_set_disable_3d">
<return type="void" />
- <argument index="0" name="viewport" type="RID" />
- <argument index="1" name="disable" type="bool" />
+ <param index="0" name="viewport" type="RID" />
+ <param index="1" name="disable" type="bool" />
<description>
</description>
</method>
<method name="viewport_set_disable_environment">
<return type="void" />
- <argument index="0" name="viewport" type="RID" />
- <argument index="1" name="disabled" type="bool" />
+ <param index="0" name="viewport" type="RID" />
+ <param index="1" name="disabled" type="bool" />
<description>
If [code]true[/code], rendering of a viewport's environment is disabled.
</description>
</method>
- <method name="viewport_set_fsr_mipmap_bias">
- <return type="void" />
- <argument index="0" name="viewport" type="RID" />
- <argument index="1" name="mipmap_bias" type="float" />
- <description>
- Affects the final texture sharpness by reading from a lower or higher mipmap. Negative values make textures sharper, while positive values make textures blurrier. When using FSR, this value is used to adjust the mipmap bias calculated internally which is based on the selected quality. The formula for this is [code]-log2(1.0 / scale) + mipmap_bias[/code]
- </description>
- </method>
<method name="viewport_set_fsr_sharpness">
<return type="void" />
- <argument index="0" name="viewport" type="RID" />
- <argument index="1" name="sharpness" type="float" />
+ <param index="0" name="viewport" type="RID" />
+ <param index="1" name="sharpness" type="float" />
<description>
Determines how sharp the upscaled image will be when using the FSR upscaling mode. Sharpness halves with every whole number. Values go from 0.0 (sharpest) to 2.0. Values above 2.0 won't make a visible difference.
</description>
</method>
<method name="viewport_set_global_canvas_transform">
<return type="void" />
- <argument index="0" name="viewport" type="RID" />
- <argument index="1" name="transform" type="Transform2D" />
+ <param index="0" name="viewport" type="RID" />
+ <param index="1" name="transform" type="Transform2D" />
<description>
Sets the viewport's global transformation matrix.
</description>
</method>
<method name="viewport_set_measure_render_time">
<return type="void" />
- <argument index="0" name="viewport" type="RID" />
- <argument index="1" name="enable" type="bool" />
+ <param index="0" name="viewport" type="RID" />
+ <param index="1" name="enable" type="bool" />
+ <description>
+ </description>
+ </method>
+ <method name="viewport_set_msaa_2d">
+ <return type="void" />
+ <param index="0" name="viewport" type="RID" />
+ <param index="1" name="msaa" type="int" enum="RenderingServer.ViewportMSAA" />
<description>
+ Sets the multisample anti-aliasing mode for 2D/Canvas. See [enum ViewportMSAA] for options.
</description>
</method>
- <method name="viewport_set_msaa">
+ <method name="viewport_set_msaa_3d">
<return type="void" />
- <argument index="0" name="viewport" type="RID" />
- <argument index="1" name="msaa" type="int" enum="RenderingServer.ViewportMSAA" />
+ <param index="0" name="viewport" type="RID" />
+ <param index="1" name="msaa" type="int" enum="RenderingServer.ViewportMSAA" />
<description>
- Sets the anti-aliasing mode. See [enum ViewportMSAA] for options.
+ Sets the multisample anti-aliasing mode for 3D. See [enum ViewportMSAA] for options.
</description>
</method>
<method name="viewport_set_occlusion_culling_build_quality">
<return type="void" />
- <argument index="0" name="quality" type="int" enum="RenderingServer.ViewportOcclusionCullingBuildQuality" />
+ <param index="0" name="quality" type="int" enum="RenderingServer.ViewportOcclusionCullingBuildQuality" />
<description>
</description>
</method>
<method name="viewport_set_occlusion_rays_per_thread">
<return type="void" />
- <argument index="0" name="rays_per_thread" type="int" />
+ <param index="0" name="rays_per_thread" type="int" />
<description>
</description>
</method>
<method name="viewport_set_parent_viewport">
<return type="void" />
- <argument index="0" name="viewport" type="RID" />
- <argument index="1" name="parent_viewport" type="RID" />
+ <param index="0" name="viewport" type="RID" />
+ <param index="1" name="parent_viewport" type="RID" />
<description>
Sets the viewport's parent to another viewport.
</description>
</method>
<method name="viewport_set_positional_shadow_atlas_quadrant_subdivision">
<return type="void" />
- <argument index="0" name="viewport" type="RID" />
- <argument index="1" name="quadrant" type="int" />
- <argument index="2" name="subdivision" type="int" />
+ <param index="0" name="viewport" type="RID" />
+ <param index="1" name="quadrant" type="int" />
+ <param index="2" name="subdivision" type="int" />
<description>
Sets the shadow atlas quadrant's subdivision.
</description>
</method>
<method name="viewport_set_positional_shadow_atlas_size">
<return type="void" />
- <argument index="0" name="viewport" type="RID" />
- <argument index="1" name="size" type="int" />
- <argument index="2" name="use_16_bits" type="bool" default="false" />
+ <param index="0" name="viewport" type="RID" />
+ <param index="1" name="size" type="int" />
+ <param index="2" name="use_16_bits" type="bool" default="false" />
<description>
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.
[b]Note:[/b] If this is set to [code]0[/code], no shadows will be visible at all (including directional shadows).
@@ -3255,24 +3295,24 @@
</method>
<method name="viewport_set_render_direct_to_screen">
<return type="void" />
- <argument index="0" name="viewport" type="RID" />
- <argument index="1" name="enabled" type="bool" />
+ <param index="0" name="viewport" type="RID" />
+ <param index="1" name="enabled" type="bool" />
<description>
If [code]true[/code], 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 [code]SCREEN_TEXTURE[/code]. 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.
</description>
</method>
<method name="viewport_set_scaling_3d_mode">
<return type="void" />
- <argument index="0" name="viewport" type="RID" />
- <argument index="1" name="scaling_3d_mode" type="int" enum="RenderingServer.ViewportScaling3DMode" />
+ <param index="0" name="viewport" type="RID" />
+ <param index="1" name="scaling_3d_mode" type="int" enum="RenderingServer.ViewportScaling3DMode" />
<description>
Sets scaling 3d mode. Bilinear scaling renders at different resolution to either undersample or supersample the viewport. FidelityFX Super Resolution 1.0, abbreviated to FSR, is an upscaling technology that produces high quality images at fast framerates by using a spatially aware upscaling algorithm. FSR is slightly more expensive than bilinear, but it produces significantly higher image quality. FSR should be used where possible.
</description>
</method>
<method name="viewport_set_scaling_3d_scale">
<return type="void" />
- <argument index="0" name="viewport" type="RID" />
- <argument index="1" name="scale" type="float" />
+ <param index="0" name="viewport" type="RID" />
+ <param index="1" name="scale" type="float" />
<description>
Scales the 3D render buffer based on the viewport size uses an image filter specified in [enum ViewportScaling3DMode] to scale the output image to the full viewport size. Values lower than [code]1.0[/code] can be used to speed up 3D rendering at the cost of quality (undersampling). Values greater than [code]1.0[/code] are only valid for bilinear mode and can be used to improve 3D rendering quality at a high performance cost (supersampling). See also [enum ViewportMSAA] for multi-sample antialiasing, which is significantly cheaper but only smoothens the edges of polygons.
When using FSR upscaling, AMD recommends exposing the following values as preset options to users "Ultra Quality: 0.77", "Quality: 0.67", "Balanced: 0.59", "Performance: 0.5" instead of exposing the entire scale.
@@ -3280,8 +3320,8 @@
</method>
<method name="viewport_set_scenario">
<return type="void" />
- <argument index="0" name="viewport" type="RID" />
- <argument index="1" name="scenario" type="RID" />
+ <param index="0" name="viewport" type="RID" />
+ <param index="1" name="scenario" type="RID" />
<description>
Sets a viewport's scenario.
The scenario contains information about environment information, reflection atlas etc.
@@ -3289,100 +3329,109 @@
</method>
<method name="viewport_set_screen_space_aa">
<return type="void" />
- <argument index="0" name="viewport" type="RID" />
- <argument index="1" name="mode" type="int" enum="RenderingServer.ViewportScreenSpaceAA" />
+ <param index="0" name="viewport" type="RID" />
+ <param index="1" name="mode" type="int" enum="RenderingServer.ViewportScreenSpaceAA" />
<description>
</description>
</method>
<method name="viewport_set_sdf_oversize_and_scale">
<return type="void" />
- <argument index="0" name="viewport" type="RID" />
- <argument index="1" name="oversize" type="int" enum="RenderingServer.ViewportSDFOversize" />
- <argument index="2" name="scale" type="int" enum="RenderingServer.ViewportSDFScale" />
+ <param index="0" name="viewport" type="RID" />
+ <param index="1" name="oversize" type="int" enum="RenderingServer.ViewportSDFOversize" />
+ <param index="2" name="scale" type="int" enum="RenderingServer.ViewportSDFScale" />
<description>
</description>
</method>
<method name="viewport_set_size">
<return type="void" />
- <argument index="0" name="viewport" type="RID" />
- <argument index="1" name="width" type="int" />
- <argument index="2" name="height" type="int" />
+ <param index="0" name="viewport" type="RID" />
+ <param index="1" name="width" type="int" />
+ <param index="2" name="height" type="int" />
<description>
Sets the viewport's width and height.
</description>
</method>
<method name="viewport_set_snap_2d_transforms_to_pixel">
<return type="void" />
- <argument index="0" name="viewport" type="RID" />
- <argument index="1" name="enabled" type="bool" />
+ <param index="0" name="viewport" type="RID" />
+ <param index="1" name="enabled" type="bool" />
<description>
</description>
</method>
<method name="viewport_set_snap_2d_vertices_to_pixel">
<return type="void" />
- <argument index="0" name="viewport" type="RID" />
- <argument index="1" name="enabled" type="bool" />
+ <param index="0" name="viewport" type="RID" />
+ <param index="1" name="enabled" type="bool" />
<description>
</description>
</method>
+ <method name="viewport_set_texture_mipmap_bias">
+ <return type="void" />
+ <param index="0" name="viewport" type="RID" />
+ <param index="1" name="mipmap_bias" type="float" />
+ <description>
+ Affects the final texture sharpness by reading from a lower or higher mipmap (also called "texture LOD bias"). Negative values make mipmapped textures sharper but grainier when viewed at a distance, while positive values make mipmapped textures blurrier (even when up close). To get sharper textures at a distance without introducing too much graininess, set this between [code]-0.75[/code] and [code]0.0[/code]. Enabling temporal antialiasing ([member ProjectSettings.rendering/anti_aliasing/quality/use_taa]) can help reduce the graininess visible when using negative mipmap bias.
+ [b]Note:[/b] When the 3D scaling mode is set to FSR 1.0, this value is used to adjust the automatic mipmap bias which is calculated internally based on the scale factor. The formula for this is [code]-log2(1.0 / scale) + mipmap_bias[/code].
+ </description>
+ </method>
<method name="viewport_set_transparent_background">
<return type="void" />
- <argument index="0" name="viewport" type="RID" />
- <argument index="1" name="enabled" type="bool" />
+ <param index="0" name="viewport" type="RID" />
+ <param index="1" name="enabled" type="bool" />
<description>
If [code]true[/code], the viewport renders its background as transparent.
</description>
</method>
<method name="viewport_set_update_mode">
<return type="void" />
- <argument index="0" name="viewport" type="RID" />
- <argument index="1" name="update_mode" type="int" enum="RenderingServer.ViewportUpdateMode" />
+ <param index="0" name="viewport" type="RID" />
+ <param index="1" name="update_mode" type="int" enum="RenderingServer.ViewportUpdateMode" />
<description>
Sets when the viewport should be updated. See [enum ViewportUpdateMode] constants for options.
</description>
</method>
<method name="viewport_set_use_debanding">
<return type="void" />
- <argument index="0" name="viewport" type="RID" />
- <argument index="1" name="enable" type="bool" />
+ <param index="0" name="viewport" type="RID" />
+ <param index="1" name="enable" type="bool" />
<description>
</description>
</method>
<method name="viewport_set_use_occlusion_culling">
<return type="void" />
- <argument index="0" name="viewport" type="RID" />
- <argument index="1" name="enable" type="bool" />
+ <param index="0" name="viewport" type="RID" />
+ <param index="1" name="enable" type="bool" />
<description>
</description>
</method>
<method name="viewport_set_use_taa">
<return type="void" />
- <argument index="0" name="viewport" type="RID" />
- <argument index="1" name="enable" type="bool" />
+ <param index="0" name="viewport" type="RID" />
+ <param index="1" name="enable" type="bool" />
<description>
If [code]true[/code], use Temporal Anti-Aliasing.
</description>
</method>
<method name="viewport_set_use_xr">
<return type="void" />
- <argument index="0" name="viewport" type="RID" />
- <argument index="1" name="use_xr" type="bool" />
+ <param index="0" name="viewport" type="RID" />
+ <param index="1" name="use_xr" type="bool" />
<description>
If [code]true[/code], the viewport uses augmented or virtual reality technologies. See [XRInterface].
</description>
</method>
<method name="viewport_set_vrs_mode">
<return type="void" />
- <argument index="0" name="viewport" type="RID" />
- <argument index="1" name="mode" type="int" enum="RenderingServer.ViewportVRSMode" />
+ <param index="0" name="viewport" type="RID" />
+ <param index="1" name="mode" type="int" enum="RenderingServer.ViewportVRSMode" />
<description>
Sets the Variable Rate Shading (VRS) mode for the viewport. Note, if hardware does not support VRS this property is ignored.
</description>
</method>
<method name="viewport_set_vrs_texture">
<return type="void" />
- <argument index="0" name="viewport" type="RID" />
- <argument index="1" name="texture" type="RID" />
+ <param index="0" name="viewport" type="RID" />
+ <param index="1" name="texture" type="RID" />
<description>
Texture to use when the VRS mode is set to [constant RenderingServer.VIEWPORT_VRS_TEXTURE].
</description>
@@ -3394,29 +3443,29 @@
</method>
<method name="visibility_notifier_set_aabb">
<return type="void" />
- <argument index="0" name="notifier" type="RID" />
- <argument index="1" name="aabb" type="AABB" />
+ <param index="0" name="notifier" type="RID" />
+ <param index="1" name="aabb" type="AABB" />
<description>
</description>
</method>
<method name="visibility_notifier_set_callbacks">
<return type="void" />
- <argument index="0" name="notifier" type="RID" />
- <argument index="1" name="enter_callable" type="Callable" />
- <argument index="2" name="exit_callable" type="Callable" />
+ <param index="0" name="notifier" type="RID" />
+ <param index="1" name="enter_callable" type="Callable" />
+ <param index="2" name="exit_callable" type="Callable" />
<description>
</description>
</method>
<method name="voxel_gi_allocate_data">
<return type="void" />
- <argument index="0" name="voxel_gi" type="RID" />
- <argument index="1" name="to_cell_xform" type="Transform3D" />
- <argument index="2" name="aabb" type="AABB" />
- <argument index="3" name="octree_size" type="Vector3i" />
- <argument index="4" name="octree_cells" type="PackedByteArray" />
- <argument index="5" name="data_cells" type="PackedByteArray" />
- <argument index="6" name="distance_field" type="PackedByteArray" />
- <argument index="7" name="level_counts" type="PackedInt32Array" />
+ <param index="0" name="voxel_gi" type="RID" />
+ <param index="1" name="to_cell_xform" type="Transform3D" />
+ <param index="2" name="aabb" type="AABB" />
+ <param index="3" name="octree_size" type="Vector3i" />
+ <param index="4" name="octree_cells" type="PackedByteArray" />
+ <param index="5" name="data_cells" type="PackedByteArray" />
+ <param index="6" name="distance_field" type="PackedByteArray" />
+ <param index="7" name="level_counts" type="PackedInt32Array" />
<description>
</description>
</method>
@@ -3427,92 +3476,100 @@
</method>
<method name="voxel_gi_get_data_cells" qualifiers="const">
<return type="PackedByteArray" />
- <argument index="0" name="voxel_gi" type="RID" />
+ <param index="0" name="voxel_gi" type="RID" />
<description>
</description>
</method>
<method name="voxel_gi_get_distance_field" qualifiers="const">
<return type="PackedByteArray" />
- <argument index="0" name="voxel_gi" type="RID" />
+ <param index="0" name="voxel_gi" type="RID" />
<description>
</description>
</method>
<method name="voxel_gi_get_level_counts" qualifiers="const">
<return type="PackedInt32Array" />
- <argument index="0" name="voxel_gi" type="RID" />
+ <param index="0" name="voxel_gi" type="RID" />
<description>
</description>
</method>
<method name="voxel_gi_get_octree_cells" qualifiers="const">
<return type="PackedByteArray" />
- <argument index="0" name="voxel_gi" type="RID" />
+ <param index="0" name="voxel_gi" type="RID" />
<description>
</description>
</method>
<method name="voxel_gi_get_octree_size" qualifiers="const">
<return type="Vector3i" />
- <argument index="0" name="voxel_gi" type="RID" />
+ <param index="0" name="voxel_gi" type="RID" />
<description>
</description>
</method>
<method name="voxel_gi_get_to_cell_xform" qualifiers="const">
<return type="Transform3D" />
- <argument index="0" name="voxel_gi" type="RID" />
+ <param index="0" name="voxel_gi" type="RID" />
+ <description>
+ </description>
+ </method>
+ <method name="voxel_gi_set_baked_exposure_normalization">
+ <return type="void" />
+ <param index="0" name="voxel_gi" type="RID" />
+ <param index="1" name="baked_exposure" type="float" />
<description>
+ Used to inform the renderer what exposure normalization value was used while baking the voxel gi. This value will be used and modulated at run time to ensure that the voxel gi maintains a consistent level of exposure even if the scene-wide exposure normalization is changed at run time. For more information see [method camera_attributes_set_exposure].
</description>
</method>
<method name="voxel_gi_set_bias">
<return type="void" />
- <argument index="0" name="voxel_gi" type="RID" />
- <argument index="1" name="bias" type="float" />
+ <param index="0" name="voxel_gi" type="RID" />
+ <param index="1" name="bias" type="float" />
<description>
</description>
</method>
<method name="voxel_gi_set_dynamic_range">
<return type="void" />
- <argument index="0" name="voxel_gi" type="RID" />
- <argument index="1" name="range" type="float" />
+ <param index="0" name="voxel_gi" type="RID" />
+ <param index="1" name="range" type="float" />
<description>
</description>
</method>
<method name="voxel_gi_set_energy">
<return type="void" />
- <argument index="0" name="voxel_gi" type="RID" />
- <argument index="1" name="energy" type="float" />
+ <param index="0" name="voxel_gi" type="RID" />
+ <param index="1" name="energy" type="float" />
<description>
</description>
</method>
<method name="voxel_gi_set_interior">
<return type="void" />
- <argument index="0" name="voxel_gi" type="RID" />
- <argument index="1" name="enable" type="bool" />
+ <param index="0" name="voxel_gi" type="RID" />
+ <param index="1" name="enable" type="bool" />
<description>
</description>
</method>
<method name="voxel_gi_set_normal_bias">
<return type="void" />
- <argument index="0" name="voxel_gi" type="RID" />
- <argument index="1" name="bias" type="float" />
+ <param index="0" name="voxel_gi" type="RID" />
+ <param index="1" name="bias" type="float" />
<description>
</description>
</method>
<method name="voxel_gi_set_propagation">
<return type="void" />
- <argument index="0" name="voxel_gi" type="RID" />
- <argument index="1" name="amount" type="float" />
+ <param index="0" name="voxel_gi" type="RID" />
+ <param index="1" name="amount" type="float" />
<description>
</description>
</method>
<method name="voxel_gi_set_quality">
<return type="void" />
- <argument index="0" name="quality" type="int" enum="RenderingServer.VoxelGIQuality" />
+ <param index="0" name="quality" type="int" enum="RenderingServer.VoxelGIQuality" />
<description>
</description>
</method>
<method name="voxel_gi_set_use_two_bounces">
<return type="void" />
- <argument index="0" name="voxel_gi" type="RID" />
- <argument index="1" name="enable" type="bool" />
+ <param index="0" name="voxel_gi" type="RID" />
+ <param index="1" name="enable" type="bool" />
<description>
</description>
</method>
@@ -3746,14 +3803,22 @@
Use [Transform3D] to store MultiMesh transform.
</constant>
<constant name="LIGHT_PROJECTOR_FILTER_NEAREST" value="0" enum="LightProjectorFilter">
+ Nearest-neighbor filter for light projectors (use for pixel art light projectors). No mipmaps are used for rendering, which means light projectors at a distance will look sharp but grainy. This has roughly the same performance cost as using mipmaps.
</constant>
- <constant name="LIGHT_PROJECTOR_FILTER_NEAREST_MIPMAPS" value="1" enum="LightProjectorFilter">
+ <constant name="LIGHT_PROJECTOR_FILTER_LINEAR" value="1" enum="LightProjectorFilter">
+ Linear filter for light projectors (use for non-pixel art light projectors). No mipmaps are used for rendering, which means light projectors at a distance will look smooth but blurry. This has roughly the same performance cost as using mipmaps.
</constant>
- <constant name="LIGHT_PROJECTOR_FILTER_LINEAR" value="2" enum="LightProjectorFilter">
+ <constant name="LIGHT_PROJECTOR_FILTER_NEAREST_MIPMAPS" value="2" enum="LightProjectorFilter">
+ Nearest-neighbor filter for light projectors (use for pixel art light projectors). Isotropic mipmaps are used for rendering, which means light projectors at a distance will look smooth but blurry. This has roughly the same performance cost as not using mipmaps.
</constant>
<constant name="LIGHT_PROJECTOR_FILTER_LINEAR_MIPMAPS" value="3" enum="LightProjectorFilter">
+ Linear filter for light projectors (use for non-pixel art light projectors). Isotropic mipmaps are used for rendering, which means light projectors at a distance will look smooth but blurry. This has roughly the same performance cost as not using mipmaps.
</constant>
- <constant name="LIGHT_PROJECTOR_FILTER_LINEAR_MIPMAPS_ANISOTROPIC" value="4" enum="LightProjectorFilter">
+ <constant name="LIGHT_PROJECTOR_FILTER_NEAREST_MIPMAPS_ANISOTROPIC" value="4" enum="LightProjectorFilter">
+ Nearest-neighbor filter for light projectors (use for pixel art light projectors). Anisotropic mipmaps are used for rendering, which means light projectors at a distance will look smooth and sharp when viewed from oblique angles. This looks better compared to isotropic mipmaps, but is slower. The level of anisotropic filtering is defined by [member ProjectSettings.rendering/textures/default_filters/anisotropic_filtering_level].
+ </constant>
+ <constant name="LIGHT_PROJECTOR_FILTER_LINEAR_MIPMAPS_ANISOTROPIC" value="5" enum="LightProjectorFilter">
+ Linear filter for light projectors (use for non-pixel art light projectors). Anisotropic mipmaps are used for rendering, which means light projectors at a distance will look smooth and sharp when viewed from oblique angles. This looks better compared to isotropic mipmaps, but is slower. The level of anisotropic filtering is defined by [member ProjectSettings.rendering/textures/default_filters/anisotropic_filtering_level].
</constant>
<constant name="LIGHT_DIRECTIONAL" value="0" enum="LightType">
Is a directional (sun) light.
@@ -3765,60 +3830,65 @@
Is a spot light.
</constant>
<constant name="LIGHT_PARAM_ENERGY" value="0" enum="LightParam">
- The light's energy.
+ The light's energy multiplier.
</constant>
<constant name="LIGHT_PARAM_INDIRECT_ENERGY" value="1" enum="LightParam">
+ The light's indirect energy multiplier (final indirect energy is [constant LIGHT_PARAM_ENERGY] * [constant LIGHT_PARAM_INDIRECT_ENERGY]).
+ </constant>
+ <constant name="LIGHT_PARAM_VOLUMETRIC_FOG_ENERGY" value="2" enum="LightParam">
+ The light's volumetric fog energy multiplier (final volumetric fog energy is [constant LIGHT_PARAM_ENERGY] * [constant LIGHT_PARAM_VOLUMETRIC_FOG_ENERGY]).
</constant>
- <constant name="LIGHT_PARAM_SPECULAR" value="2" enum="LightParam">
+ <constant name="LIGHT_PARAM_SPECULAR" value="3" enum="LightParam">
The light's influence on specularity.
</constant>
- <constant name="LIGHT_PARAM_RANGE" value="3" enum="LightParam">
+ <constant name="LIGHT_PARAM_RANGE" value="4" enum="LightParam">
The light's range.
</constant>
- <constant name="LIGHT_PARAM_SIZE" value="4" enum="LightParam">
+ <constant name="LIGHT_PARAM_SIZE" value="5" enum="LightParam">
The size of the light when using spot light or omni light. The angular size of the light when using directional light.
</constant>
- <constant name="LIGHT_PARAM_ATTENUATION" value="5" enum="LightParam">
+ <constant name="LIGHT_PARAM_ATTENUATION" value="6" enum="LightParam">
The light's attenuation.
</constant>
- <constant name="LIGHT_PARAM_SPOT_ANGLE" value="6" enum="LightParam">
+ <constant name="LIGHT_PARAM_SPOT_ANGLE" value="7" enum="LightParam">
The spotlight's angle.
</constant>
- <constant name="LIGHT_PARAM_SPOT_ATTENUATION" value="7" enum="LightParam">
+ <constant name="LIGHT_PARAM_SPOT_ATTENUATION" value="8" enum="LightParam">
The spotlight's attenuation.
</constant>
- <constant name="LIGHT_PARAM_SHADOW_MAX_DISTANCE" value="8" enum="LightParam">
+ <constant name="LIGHT_PARAM_SHADOW_MAX_DISTANCE" value="9" enum="LightParam">
Max distance that shadows will be rendered.
</constant>
- <constant name="LIGHT_PARAM_SHADOW_SPLIT_1_OFFSET" value="9" enum="LightParam">
+ <constant name="LIGHT_PARAM_SHADOW_SPLIT_1_OFFSET" value="10" enum="LightParam">
Proportion of shadow atlas occupied by the first split.
</constant>
- <constant name="LIGHT_PARAM_SHADOW_SPLIT_2_OFFSET" value="10" enum="LightParam">
+ <constant name="LIGHT_PARAM_SHADOW_SPLIT_2_OFFSET" value="11" enum="LightParam">
Proportion of shadow atlas occupied by the second split.
</constant>
- <constant name="LIGHT_PARAM_SHADOW_SPLIT_3_OFFSET" value="11" enum="LightParam">
+ <constant name="LIGHT_PARAM_SHADOW_SPLIT_3_OFFSET" value="12" enum="LightParam">
Proportion of shadow atlas occupied by the third split. The fourth split occupies the rest.
</constant>
- <constant name="LIGHT_PARAM_SHADOW_FADE_START" value="12" enum="LightParam">
+ <constant name="LIGHT_PARAM_SHADOW_FADE_START" value="13" enum="LightParam">
Proportion of shadow max distance where the shadow will start to fade out.
</constant>
- <constant name="LIGHT_PARAM_SHADOW_NORMAL_BIAS" value="13" enum="LightParam">
+ <constant name="LIGHT_PARAM_SHADOW_NORMAL_BIAS" value="14" enum="LightParam">
Normal bias used to offset shadow lookup by object normal. Can be used to fix self-shadowing artifacts.
</constant>
- <constant name="LIGHT_PARAM_SHADOW_BIAS" value="14" enum="LightParam">
+ <constant name="LIGHT_PARAM_SHADOW_BIAS" value="15" enum="LightParam">
Bias the shadow lookup to fix self-shadowing artifacts.
</constant>
- <constant name="LIGHT_PARAM_SHADOW_PANCAKE_SIZE" value="15" enum="LightParam">
+ <constant name="LIGHT_PARAM_SHADOW_PANCAKE_SIZE" value="16" enum="LightParam">
Sets the size of the directional shadow pancake. The pancake offsets the start of the shadow's camera frustum to provide a higher effective depth resolution for the shadow. However, a high pancake size can cause artifacts in the shadows of large objects that are close to the edge of the frustum. Reducing the pancake size can help. Setting the size to [code]0[/code] turns off the pancaking effect.
</constant>
- <constant name="LIGHT_PARAM_SHADOW_BLUR" value="16" enum="LightParam">
- Blurs the edges of the shadow. Can be used to hide pixel artifacts in low resolution shadow maps. A high value can make shadows appear grainy and can cause other unwanted artifacts. Try to keep as near default as possible.
+ <constant name="LIGHT_PARAM_SHADOW_OPACITY" value="17" enum="LightParam">
+ The light's shadow opacity. Values lower than [code]1.0[/code] make the light appear through shadows. This can be used to fake global illumination at a low performance cost.
</constant>
- <constant name="LIGHT_PARAM_SHADOW_VOLUMETRIC_FOG_FADE" value="17" enum="LightParam">
+ <constant name="LIGHT_PARAM_SHADOW_BLUR" value="18" enum="LightParam">
+ Blurs the edges of the shadow. Can be used to hide pixel artifacts in low resolution shadow maps. A high value can make shadows appear grainy and can cause other unwanted artifacts. Try to keep as near default as possible.
</constant>
- <constant name="LIGHT_PARAM_TRANSMITTANCE_BIAS" value="18" enum="LightParam">
+ <constant name="LIGHT_PARAM_TRANSMITTANCE_BIAS" value="19" enum="LightParam">
</constant>
- <constant name="LIGHT_PARAM_MAX" value="19" enum="LightParam">
+ <constant name="LIGHT_PARAM_MAX" value="21" enum="LightParam">
Represents the size of the [enum LightParam] enum.
</constant>
<constant name="LIGHT_BAKE_DISABLED" value="0" enum="LightBakeMode">
@@ -3895,14 +3965,22 @@
<constant name="DECAL_TEXTURE_MAX" value="4" enum="DecalTexture">
</constant>
<constant name="DECAL_FILTER_NEAREST" value="0" enum="DecalFilter">
+ Nearest-neighbor filter for decals (use for pixel art decals). No mipmaps are used for rendering, which means decals at a distance will look sharp but grainy. This has roughly the same performance cost as using mipmaps.
</constant>
- <constant name="DECAL_FILTER_NEAREST_MIPMAPS" value="1" enum="DecalFilter">
+ <constant name="DECAL_FILTER_LINEAR" value="1" enum="DecalFilter">
+ Linear filter for decals (use for non-pixel art decals). No mipmaps are used for rendering, which means decals at a distance will look smooth but blurry. This has roughly the same performance cost as using mipmaps.
</constant>
- <constant name="DECAL_FILTER_LINEAR" value="2" enum="DecalFilter">
+ <constant name="DECAL_FILTER_NEAREST_MIPMAPS" value="2" enum="DecalFilter">
+ Nearest-neighbor filter for decals (use for pixel art decals). Isotropic mipmaps are used for rendering, which means decals at a distance will look smooth but blurry. This has roughly the same performance cost as not using mipmaps.
</constant>
<constant name="DECAL_FILTER_LINEAR_MIPMAPS" value="3" enum="DecalFilter">
+ Linear filter for decals (use for non-pixel art decals). Isotropic mipmaps are used for rendering, which means decals at a distance will look smooth but blurry. This has roughly the same performance cost as not using mipmaps.
+ </constant>
+ <constant name="DECAL_FILTER_NEAREST_MIPMAPS_ANISOTROPIC" value="4" enum="DecalFilter">
+ Nearest-neighbor filter for decals (use for pixel art decals). Anisotropic mipmaps are used for rendering, which means decals at a distance will look smooth and sharp when viewed from oblique angles. This looks better compared to isotropic mipmaps, but is slower. The level of anisotropic filtering is defined by [member ProjectSettings.rendering/textures/default_filters/anisotropic_filtering_level].
</constant>
- <constant name="DECAL_FILTER_LINEAR_MIPMAPS_ANISOTROPIC" value="4" enum="DecalFilter">
+ <constant name="DECAL_FILTER_LINEAR_MIPMAPS_ANISOTROPIC" value="5" enum="DecalFilter">
+ Linear filter for decals (use for non-pixel art decals). Anisotropic mipmaps are used for rendering, which means decals at a distance will look smooth and sharp when viewed from oblique angles. This looks better compared to isotropic mipmaps, but is slower. The level of anisotropic filtering is defined by [member ProjectSettings.rendering/textures/default_filters/anisotropic_filtering_level].
</constant>
<constant name="VOXEL_GI_QUALITY_LOW" value="0" enum="VoxelGIQuality">
</constant>
@@ -4536,63 +4614,63 @@
<constant name="CANVAS_OCCLUDER_POLYGON_CULL_COUNTER_CLOCKWISE" value="2" enum="CanvasOccluderPolygonCullMode">
Culling of the canvas occluder is counterclockwise.
</constant>
- <constant name="GLOBAL_VAR_TYPE_BOOL" value="0" enum="GlobalVariableType">
+ <constant name="GLOBAL_VAR_TYPE_BOOL" value="0" enum="GlobalShaderParameterType">
</constant>
- <constant name="GLOBAL_VAR_TYPE_BVEC2" value="1" enum="GlobalVariableType">
+ <constant name="GLOBAL_VAR_TYPE_BVEC2" value="1" enum="GlobalShaderParameterType">
</constant>
- <constant name="GLOBAL_VAR_TYPE_BVEC3" value="2" enum="GlobalVariableType">
+ <constant name="GLOBAL_VAR_TYPE_BVEC3" value="2" enum="GlobalShaderParameterType">
</constant>
- <constant name="GLOBAL_VAR_TYPE_BVEC4" value="3" enum="GlobalVariableType">
+ <constant name="GLOBAL_VAR_TYPE_BVEC4" value="3" enum="GlobalShaderParameterType">
</constant>
- <constant name="GLOBAL_VAR_TYPE_INT" value="4" enum="GlobalVariableType">
+ <constant name="GLOBAL_VAR_TYPE_INT" value="4" enum="GlobalShaderParameterType">
</constant>
- <constant name="GLOBAL_VAR_TYPE_IVEC2" value="5" enum="GlobalVariableType">
+ <constant name="GLOBAL_VAR_TYPE_IVEC2" value="5" enum="GlobalShaderParameterType">
</constant>
- <constant name="GLOBAL_VAR_TYPE_IVEC3" value="6" enum="GlobalVariableType">
+ <constant name="GLOBAL_VAR_TYPE_IVEC3" value="6" enum="GlobalShaderParameterType">
</constant>
- <constant name="GLOBAL_VAR_TYPE_IVEC4" value="7" enum="GlobalVariableType">
+ <constant name="GLOBAL_VAR_TYPE_IVEC4" value="7" enum="GlobalShaderParameterType">
</constant>
- <constant name="GLOBAL_VAR_TYPE_RECT2I" value="8" enum="GlobalVariableType">
+ <constant name="GLOBAL_VAR_TYPE_RECT2I" value="8" enum="GlobalShaderParameterType">
</constant>
- <constant name="GLOBAL_VAR_TYPE_UINT" value="9" enum="GlobalVariableType">
+ <constant name="GLOBAL_VAR_TYPE_UINT" value="9" enum="GlobalShaderParameterType">
</constant>
- <constant name="GLOBAL_VAR_TYPE_UVEC2" value="10" enum="GlobalVariableType">
+ <constant name="GLOBAL_VAR_TYPE_UVEC2" value="10" enum="GlobalShaderParameterType">
</constant>
- <constant name="GLOBAL_VAR_TYPE_UVEC3" value="11" enum="GlobalVariableType">
+ <constant name="GLOBAL_VAR_TYPE_UVEC3" value="11" enum="GlobalShaderParameterType">
</constant>
- <constant name="GLOBAL_VAR_TYPE_UVEC4" value="12" enum="GlobalVariableType">
+ <constant name="GLOBAL_VAR_TYPE_UVEC4" value="12" enum="GlobalShaderParameterType">
</constant>
- <constant name="GLOBAL_VAR_TYPE_FLOAT" value="13" enum="GlobalVariableType">
+ <constant name="GLOBAL_VAR_TYPE_FLOAT" value="13" enum="GlobalShaderParameterType">
</constant>
- <constant name="GLOBAL_VAR_TYPE_VEC2" value="14" enum="GlobalVariableType">
+ <constant name="GLOBAL_VAR_TYPE_VEC2" value="14" enum="GlobalShaderParameterType">
</constant>
- <constant name="GLOBAL_VAR_TYPE_VEC3" value="15" enum="GlobalVariableType">
+ <constant name="GLOBAL_VAR_TYPE_VEC3" value="15" enum="GlobalShaderParameterType">
</constant>
- <constant name="GLOBAL_VAR_TYPE_VEC4" value="16" enum="GlobalVariableType">
+ <constant name="GLOBAL_VAR_TYPE_VEC4" value="16" enum="GlobalShaderParameterType">
</constant>
- <constant name="GLOBAL_VAR_TYPE_COLOR" value="17" enum="GlobalVariableType">
+ <constant name="GLOBAL_VAR_TYPE_COLOR" value="17" enum="GlobalShaderParameterType">
</constant>
- <constant name="GLOBAL_VAR_TYPE_RECT2" value="18" enum="GlobalVariableType">
+ <constant name="GLOBAL_VAR_TYPE_RECT2" value="18" enum="GlobalShaderParameterType">
</constant>
- <constant name="GLOBAL_VAR_TYPE_MAT2" value="19" enum="GlobalVariableType">
+ <constant name="GLOBAL_VAR_TYPE_MAT2" value="19" enum="GlobalShaderParameterType">
</constant>
- <constant name="GLOBAL_VAR_TYPE_MAT3" value="20" enum="GlobalVariableType">
+ <constant name="GLOBAL_VAR_TYPE_MAT3" value="20" enum="GlobalShaderParameterType">
</constant>
- <constant name="GLOBAL_VAR_TYPE_MAT4" value="21" enum="GlobalVariableType">
+ <constant name="GLOBAL_VAR_TYPE_MAT4" value="21" enum="GlobalShaderParameterType">
</constant>
- <constant name="GLOBAL_VAR_TYPE_TRANSFORM_2D" value="22" enum="GlobalVariableType">
+ <constant name="GLOBAL_VAR_TYPE_TRANSFORM_2D" value="22" enum="GlobalShaderParameterType">
</constant>
- <constant name="GLOBAL_VAR_TYPE_TRANSFORM" value="23" enum="GlobalVariableType">
+ <constant name="GLOBAL_VAR_TYPE_TRANSFORM" value="23" enum="GlobalShaderParameterType">
</constant>
- <constant name="GLOBAL_VAR_TYPE_SAMPLER2D" value="24" enum="GlobalVariableType">
+ <constant name="GLOBAL_VAR_TYPE_SAMPLER2D" value="24" enum="GlobalShaderParameterType">
</constant>
- <constant name="GLOBAL_VAR_TYPE_SAMPLER2DARRAY" value="25" enum="GlobalVariableType">
+ <constant name="GLOBAL_VAR_TYPE_SAMPLER2DARRAY" value="25" enum="GlobalShaderParameterType">
</constant>
- <constant name="GLOBAL_VAR_TYPE_SAMPLER3D" value="26" enum="GlobalVariableType">
+ <constant name="GLOBAL_VAR_TYPE_SAMPLER3D" value="26" enum="GlobalShaderParameterType">
</constant>
- <constant name="GLOBAL_VAR_TYPE_SAMPLERCUBE" value="27" enum="GlobalVariableType">
+ <constant name="GLOBAL_VAR_TYPE_SAMPLERCUBE" value="27" enum="GlobalShaderParameterType">
</constant>
- <constant name="GLOBAL_VAR_TYPE_MAX" value="28" enum="GlobalVariableType">
+ <constant name="GLOBAL_VAR_TYPE_MAX" value="28" enum="GlobalShaderParameterType">
</constant>
<constant name="RENDERING_INFO_TOTAL_OBJECTS_IN_FRAME" value="0" enum="RenderingInfo">
</constant>