asgardius/virtualx-engine
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
virtualx-engine/doc/classes/RenderingServer.xml

4435 lines
192 KiB
XML
Raw Normal View History

Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<?xml version="1.0" encoding="UTF-8" ?>
doc: Update classref with node renames A few extra renames for classes which were missed in last week's PRs.
2020-03-30 18:22:57 +02:00
<class name="RenderingServer" inherits="Object" version="4.0">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<brief_description>
Server for anything visible.
</brief_description>
<description>
Update many docs with recent rendering changes
2020-04-17 01:05:25 +02:00
Server for anything visible. The rendering server is the API backend for everything visible. The whole scene system mounts on it to display.
The rendering server is completely opaque, the internals are entirely implementation specific and cannot be accessed.
The rendering server can be used to bypass the scene system entirely.
Finish documenting VisualServer
2020-01-06 00:36:50 +01:00
Resources are created using the [code]*_create[/code] functions.
All objects are drawn to a viewport. You can use the [Viewport] attached to the [SceneTree] or you can create one yourself with [method viewport_create]. When using a custom scenario or canvas, the scenario or canvas needs to be attached to the viewport using [method viewport_set_scenario] or [method viewport_attach_canvas].
doc: Sync classref with current source
2020-05-04 16:55:01 +02:00
In 3D, all visual objects must be associated with a scenario. The scenario is a visual representation of the world. If accessing the rendering server from a running game, the scenario can be accessed from the scene tree from any [Node3D] node with [method Node3D.get_world_3d]. Otherwise, a scenario can be created with [method scenario_create].
class reference proofreading
2021-03-18 12:04:28 +01:00
Similarly, in 2D, a canvas is needed to draw all canvas items.
Finish documenting VisualServer
2020-01-06 00:36:50 +01:00
In 3D, all visible objects are comprised of a resource and an instance. A resource can be a mesh, a particle system, a light, or any other 3D object. In order to be visible resources must be attached to an instance using [method instance_set_base]. The instance must also be attached to the scenario using [method instance_set_scenario] in order to be visible.
In 2D, all visible objects are some form of canvas item. In order to be visible, a canvas item needs to be the child of a canvas attached to a viewport, or it needs to be the child of another canvas item that is eventually attached to the canvas.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</description>
<tutorials>
doc: Update links to latest documentation after content reorganization
2021-10-06 13:48:48 +02:00
<link title="Optimization using Servers">https://docs.godotengine.org/en/latest/tutorials/performance/using_servers.html</link>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</tutorials>
<methods>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="bake_render_uv2">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<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" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<description>
</description>
</method>
<method name="camera_create">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="RID" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<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_effects_create">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="RID" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<description>
</description>
</method>
<method name="camera_effects_set_custom_exposure">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<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" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="camera_effects_set_dof_blur">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<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" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="camera_effects_set_dof_blur_bokeh_shape">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="shape" type="int" enum="RenderingServer.DOFBokehShape" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<description>
</description>
</method>
<method name="camera_effects_set_dof_blur_quality">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="quality" type="int" enum="RenderingServer.DOFBlurQuality" />
<argument index="1" name="use_jitter" type="bool" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<description>
</description>
</method>
<method name="camera_set_camera_effects">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="camera" type="RID" />
<argument index="1" name="effects" type="RID" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
</description>
</method>
<method name="camera_set_cull_mask">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="camera" type="RID" />
<argument index="1" name="layers" type="int" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
doc: Update classref with node renames A few extra renames for classes which were missed in last week's PRs.
2020-03-30 18:22:57 +02:00
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].
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
<method name="camera_set_environment">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="camera" type="RID" />
<argument index="1" name="env" type="RID" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
doc: Update classref with node renames A few extra renames for classes which were missed in last week's PRs.
2020-03-30 18:22:57 +02:00
Sets the environment used by this camera. Equivalent to [member Camera3D.environment].
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
Added inspector plugin documentation. Fixed plugin bindings.
2019-04-23 21:39:09 +02:00
<method name="camera_set_frustum">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<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" />
Added inspector plugin documentation. Fixed plugin bindings.
2019-04-23 21:39:09 +02:00
<description>
Updated docs for many VisualServer methods
2019-12-15 01:38:19 +01:00
Sets camera to use frustum projection. This mode allows adjusting the [code]offset[/code] argument to create "tilted frustum" effects.
Added inspector plugin documentation. Fixed plugin bindings.
2019-04-23 21:39:09 +02:00
</description>
</method>
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<method name="camera_set_orthogonal">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<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" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Updated docs for many VisualServer methods
2019-12-15 01:38:19 +01:00
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.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
<method name="camera_set_perspective">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<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" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Updated docs for many VisualServer methods
2019-12-15 01:38:19 +01:00
Sets camera to use perspective projection. Objects on the screen becomes smaller when they are far away.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
<method name="camera_set_transform">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="camera" type="RID" />
<argument index="1" name="transform" type="Transform3D" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Update documentation for Transform3D
2020-05-03 10:27:36 +02:00
Sets [Transform3D] of camera.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
<method name="camera_set_use_vertical_aspect">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="camera" type="RID" />
<argument index="1" name="enable" type="bool" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
doc: Update classref with node renames A few extra renames for classes which were missed in last week's PRs.
2020-03-30 18:22:57 +02:00
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].
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<method name="canvas_create">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="RID" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
doc: Update classref with node renames A few extra renames for classes which were missed in last week's PRs.
2020-03-30 18:22:57 +02:00
Creates a canvas and returns the assigned [RID]. It can be accessed with the RID that is returned. This RID will be used in all [code]canvas_*[/code] RenderingServer functions.
Once finished with your RID, you will want to free the RID using the RenderingServer's [method free_rid] static method.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="canvas_item_add_circle">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<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" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="canvas_item_add_clip_ignore">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="item" type="RID" />
<argument index="1" name="ignore" type="bool" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="canvas_item_add_line">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<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" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="canvas_item_add_mesh">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<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" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
</description>
</method>
Implement TextServer GDExtension interface, remove TextServer GDNative interface.
2021-08-27 23:19:51 +02:00
<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" />
<description>
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="canvas_item_add_multimesh">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="item" type="RID" />
<argument index="1" name="mesh" type="RID" />
<argument index="2" name="texture" type="RID" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="canvas_item_add_nine_patch">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<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)" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="canvas_item_add_particles">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="item" type="RID" />
<argument index="1" name="particles" type="RID" />
<argument index="2" name="texture" type="RID" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="canvas_item_add_polygon">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<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" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="canvas_item_add_polyline">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<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" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="canvas_item_add_primitive">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<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" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="canvas_item_add_rect">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="item" type="RID" />
<argument index="1" name="rect" type="Rect2" />
<argument index="2" name="color" type="Color" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="canvas_item_add_set_transform">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="item" type="RID" />
<argument index="1" name="transform" type="Transform2D" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="canvas_item_add_texture_rect">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<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" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="canvas_item_add_texture_rect_region">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<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" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="canvas_item_add_triangle_array">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<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" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="canvas_item_clear">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="item" type="RID" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
Clears the [CanvasItem] and removes all commands in it.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="canvas_item_create">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="RID" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="canvas_item_set_canvas_group_mode">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<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" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="canvas_item_set_clip">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="item" type="RID" />
<argument index="1" name="clip" type="bool" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="canvas_item_set_copy_to_backbuffer">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="item" type="RID" />
<argument index="1" name="enabled" type="bool" />
<argument index="2" name="rect" type="Rect2" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
Sets the [CanvasItem] to copy a rect to the backbuffer.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="canvas_item_set_custom_rect">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<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)" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="canvas_item_set_default_texture_filter">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="item" type="RID" />
<argument index="1" name="filter" type="int" enum="RenderingServer.CanvasItemTextureFilter" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="canvas_item_set_default_texture_repeat">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="item" type="RID" />
<argument index="1" name="repeat" type="int" enum="RenderingServer.CanvasItemTextureRepeat" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="canvas_item_set_distance_field_mode">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="item" type="RID" />
<argument index="1" name="enabled" type="bool" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="canvas_item_set_draw_behind_parent">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="item" type="RID" />
<argument index="1" name="enabled" type="bool" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="canvas_item_set_draw_index">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="item" type="RID" />
<argument index="1" name="index" type="int" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
Sets the index for the [CanvasItem].
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="canvas_item_set_light_mask">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="item" type="RID" />
<argument index="1" name="mask" type="int" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="canvas_item_set_material">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="item" type="RID" />
<argument index="1" name="material" type="RID" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
Sets a new material to the [CanvasItem].
doc: Sync classref with current source + fixup some bindings Includes various changes triggered by the refactoring of method bindings.
2020-11-04 15:38:26 +01:00
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="canvas_item_set_modulate">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="item" type="RID" />
<argument index="1" name="color" type="Color" />
doc: Sync classref with current source + fixup some bindings Includes various changes triggered by the refactoring of method bindings.
2020-11-04 15:38:26 +01:00
<description>
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="canvas_item_set_parent">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="item" type="RID" />
<argument index="1" name="parent" type="RID" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="canvas_item_set_self_modulate">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="item" type="RID" />
<argument index="1" name="color" type="Color" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<description>
</description>
</method>
<method name="canvas_item_set_sort_children_by_y">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="item" type="RID" />
<argument index="1" name="enabled" type="bool" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="canvas_item_set_transform">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="item" type="RID" />
<argument index="1" name="transform" type="Transform2D" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="canvas_item_set_use_parent_material">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="item" type="RID" />
<argument index="1" name="enabled" type="bool" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
Sets if the [CanvasItem] uses its parent's material.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="canvas_item_set_visibility_notifier">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<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" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="canvas_item_set_visible">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="item" type="RID" />
<argument index="1" name="visible" type="bool" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<description>
</description>
</method>
<method name="canvas_item_set_z_as_relative_to_parent">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="item" type="RID" />
<argument index="1" name="enabled" type="bool" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
If this is enabled, the Z index of the parent will be added to the children's Z index.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="canvas_item_set_z_index">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="item" type="RID" />
<argument index="1" name="z_index" type="int" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
Sets the [CanvasItem]'s Z index, i.e. its draw order (lower indexes are drawn first).
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="canvas_light_attach_to_canvas">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="light" type="RID" />
<argument index="1" name="canvas" type="RID" />
doc: Sync classref with current source
2020-10-09 15:04:15 +02:00
<description>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
Attaches the canvas light to the canvas. Removes it from its previous canvas.
doc: Sync classref with current source
2020-10-09 15:04:15 +02:00
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="canvas_light_create">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="RID" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
Creates a canvas light and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all [code]canvas_light_*[/code] RenderingServer functions.
doc: Update classref with node renames A few extra renames for classes which were missed in last week's PRs.
2020-03-30 18:22:57 +02:00
Once finished with your RID, you will want to free the RID using the RenderingServer's [method free_rid] static method.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="canvas_light_occluder_attach_to_canvas">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="occluder" type="RID" />
<argument index="1" name="canvas" type="RID" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<description>
Attaches a light occluder to the canvas. Removes it from its previous canvas.
</description>
</method>
<method name="canvas_light_occluder_create">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="RID" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
Creates a light occluder and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all [code]canvas_light_ocluder_*[/code] RenderingServer functions.
doc: Update classref with node renames A few extra renames for classes which were missed in last week's PRs.
2020-03-30 18:22:57 +02:00
Once finished with your RID, you will want to free the RID using the RenderingServer's [method free_rid] static method.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="canvas_light_occluder_set_as_sdf_collision">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="occluder" type="RID" />
<argument index="1" name="enable" type="bool" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="canvas_light_occluder_set_enabled">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="occluder" type="RID" />
<argument index="1" name="enabled" type="bool" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
Enables or disables light occluder.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="canvas_light_occluder_set_light_mask">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="occluder" type="RID" />
<argument index="1" name="mask" type="int" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
The light mask. See [LightOccluder2D] for more information on light masks.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="canvas_light_occluder_set_polygon">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="occluder" type="RID" />
<argument index="1" name="polygon" type="RID" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
Sets a light occluder's polygon.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="canvas_light_occluder_set_transform">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="occluder" type="RID" />
<argument index="1" name="transform" type="Transform2D" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
Sets a light occluder's [Transform2D].
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="canvas_light_set_color">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="light" type="RID" />
<argument index="1" name="color" type="Color" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
Sets the color for a light.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="canvas_light_set_enabled">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="light" type="RID" />
<argument index="1" name="enabled" type="bool" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
Enables or disables a canvas light.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="canvas_light_set_energy">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="light" type="RID" />
<argument index="1" name="energy" type="float" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
Sets a canvas light's energy.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="canvas_light_set_height">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="light" type="RID" />
<argument index="1" name="height" type="float" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
Sets a canvas light's height.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="canvas_light_set_item_cull_mask">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="light" type="RID" />
<argument index="1" name="mask" type="int" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
The light mask. See [LightOccluder2D] for more information on light masks.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="canvas_light_set_item_shadow_cull_mask">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="light" type="RID" />
<argument index="1" name="mask" type="int" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
The binary mask used to determine which layers this canvas light's shadows affects. See [LightOccluder2D] for more information on light masks.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="canvas_light_set_layer_range">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<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" />
Fix VisualServer bindings.
2020-02-16 18:55:40 +01:00
<description>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
The layer range that gets rendered with this light.
Fix VisualServer bindings.
2020-02-16 18:55:40 +01:00
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="canvas_light_set_mode">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="light" type="RID" />
<argument index="1" name="mode" type="int" enum="RenderingServer.CanvasLightMode" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
The mode of the light, see [enum CanvasLightMode] constants.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="canvas_light_set_shadow_color">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="light" type="RID" />
<argument index="1" name="color" type="Color" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<description>
Sets the color of the canvas light's shadow.
</description>
</method>
<method name="canvas_light_set_shadow_enabled">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="light" type="RID" />
<argument index="1" name="enabled" type="bool" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
Enables or disables the canvas light's shadow.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="canvas_light_set_shadow_filter">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="light" type="RID" />
<argument index="1" name="filter" type="int" enum="RenderingServer.CanvasLightShadowFilter" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
Sets the canvas light's shadow's filter, see [enum CanvasLightShadowFilter] constants.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="canvas_light_set_shadow_smooth">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="light" type="RID" />
<argument index="1" name="smooth" type="float" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
Smoothens the shadow. The lower, the smoother.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="canvas_light_set_texture">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="light" type="RID" />
<argument index="1" name="texture" type="RID" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
Sets the texture to be used by a [PointLight2D]. Equivalent to [member PointLight2D.texture].
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="canvas_light_set_texture_offset">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="light" type="RID" />
<argument index="1" name="offset" type="Vector2" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
Sets the offset of a [PointLight2D]'s texture. Equivalent to [member PointLight2D.offset].
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="canvas_light_set_texture_scale">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="light" type="RID" />
<argument index="1" name="scale" type="float" />
doc: Sync classref with current source
2021-01-04 14:33:44 +01:00
<description>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
Sets the scale factor of a [PointLight2D]'s texture. Equivalent to [member PointLight2D.texture_scale].
doc: Sync classref with current source
2021-01-04 14:33:44 +01:00
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="canvas_light_set_transform">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="light" type="RID" />
<argument index="1" name="transform" type="Transform2D" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
Sets the canvas light's [Transform2D].
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="canvas_light_set_z_range">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<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" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
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].
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="canvas_occluder_polygon_create">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="RID" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
Creates a new light occluder polygon and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all [code]canvas_occluder_polygon_*[/code] RenderingServer functions.
Once finished with your RID, you will want to free the RID using the RenderingServer's [method free_rid] static method.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="canvas_occluder_polygon_set_cull_mode">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="occluder_polygon" type="RID" />
<argument index="1" name="mode" type="int" enum="RenderingServer.CanvasOccluderPolygonCullMode" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
Sets an occluder polygons cull mode. See [enum CanvasOccluderPolygonCullMode] constants.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="canvas_occluder_polygon_set_shape">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<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" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
Sets the shape of the occluder polygon.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="canvas_set_disable_scale">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="disable" type="bool" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="canvas_set_item_mirroring">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="canvas" type="RID" />
<argument index="1" name="item" type="RID" />
<argument index="2" name="mirroring" type="Vector2" />
doc: Sync classref with current source Add missing enum bindings.
2020-04-20 11:48:00 +02:00
<description>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
A copy of the canvas item will be drawn with a local offset of the mirroring [Vector2].
doc: Sync classref with current source Add missing enum bindings.
2020-04-20 11:48:00 +02:00
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="canvas_set_modulate">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="canvas" type="RID" />
<argument index="1" name="color" type="Color" />
doc: Sync classref with current source Add missing enum bindings.
2020-04-20 11:48:00 +02:00
<description>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
Modulates all colors in the given canvas.
doc: Sync classref with current source Add missing enum bindings.
2020-04-20 11:48:00 +02:00
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="canvas_set_shadow_texture_size">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="size" type="int" />
doc: Sync classref with current source Add missing enum bindings.
2020-04-20 11:48:00 +02:00
<description>
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="canvas_texture_create">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="RID" />
doc: Sync classref with current source Add missing enum bindings.
2020-04-20 11:48:00 +02:00
<description>
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="canvas_texture_set_channel">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<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" />
doc: Sync classref with current source Add missing enum bindings.
2020-04-20 11:48:00 +02:00
<description>
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="canvas_texture_set_shading_parameters">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<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" />
doc: Sync classref with current source Add missing enum bindings.
2020-04-20 11:48:00 +02:00
<description>
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="canvas_texture_set_texture_filter">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="canvas_texture" type="RID" />
<argument index="1" name="filter" type="int" enum="RenderingServer.CanvasItemTextureFilter" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="canvas_texture_set_texture_repeat">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="canvas_texture" type="RID" />
<argument index="1" name="repeat" type="int" enum="RenderingServer.CanvasItemTextureRepeat" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="create_local_rendering_device" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="RenderingDevice" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="decal_create">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="RID" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="decal_set_albedo_mix">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="decal" type="RID" />
<argument index="1" name="albedo_mix" type="float" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="decal_set_cull_mask">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="decal" type="RID" />
<argument index="1" name="mask" type="int" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="decal_set_distance_fade">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<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" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="decal_set_emission_energy">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="decal" type="RID" />
<argument index="1" name="energy" type="float" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="decal_set_extents">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="decal" type="RID" />
<argument index="1" name="extents" type="Vector3" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="decal_set_fade">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="decal" type="RID" />
<argument index="1" name="above" type="float" />
<argument index="2" name="below" type="float" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="decal_set_modulate">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="decal" type="RID" />
<argument index="1" name="color" type="Color" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<description>
</description>
</method>
<method name="decal_set_normal_fade">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="decal" type="RID" />
<argument index="1" name="fade" type="float" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<description>
</description>
</method>
<method name="decal_set_texture">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<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" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<description>
</description>
</method>
Implement more rendering options as specialization constants * Shadow quality settings now specialization constant. * Decal and light projector filters can be set. * Changing those settings forces re-creation of the pipelines. These changes should help improve performance related to shadow mapping, and allows improving performance by sacrificing decal and light projector quality.
2021-07-19 21:41:55 +02:00
<method name="decals_set_filter">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="filter" type="int" enum="RenderingServer.DecalFilter" />
Implement more rendering options as specialization constants * Shadow quality settings now specialization constant. * Decal and light projector filters can be set. * Changing those settings forces re-creation of the pipelines. These changes should help improve performance related to shadow mapping, and allows improving performance by sacrificing decal and light projector quality.
2021-07-19 21:41:55 +02:00
<description>
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="directional_light_create">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="RID" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<description>
Creates a directional light and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID can be used in most [code]light_*[/code] RenderingServer functions.
Once finished with your RID, you will want to free the RID using the RenderingServer's [method free_rid] static method.
To place in a scene, attach this directional light to an instance using [method instance_set_base] using the returned RID.
</description>
</method>
<method name="directional_shadow_atlas_set_size">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="size" type="int" />
<argument index="1" name="is_16bits" type="bool" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<description>
</description>
</method>
<method name="directional_shadow_quality_set">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="quality" type="int" enum="RenderingServer.ShadowQuality" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<description>
</description>
</method>
<method name="environment_bake_panorama">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<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" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<description>
</description>
</method>
<method name="environment_create">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="RID" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<description>
Creates an environment and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all [code]environment_*[/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="environment_glow_set_use_bicubic_upscale">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="enable" type="bool" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<description>
</description>
</method>
<method name="environment_glow_set_use_high_quality">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="enable" type="bool" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<description>
</description>
</method>
<method name="environment_set_adjustment">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<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" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<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">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<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" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<description>
</description>
</method>
<method name="environment_set_background">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="env" type="RID" />
<argument index="1" name="bg" type="int" enum="RenderingServer.EnvironmentBG" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<description>
Sets the [i]BGMode[/i] of the environment. Equivalent to [member Environment.background_mode].
</description>
</method>
<method name="environment_set_bg_color">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="env" type="RID" />
<argument index="1" name="color" type="Color" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<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">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="env" type="RID" />
<argument index="1" name="energy" type="float" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<description>
Sets the intensity of the background color.
</description>
</method>
<method name="environment_set_canvas_max_layer">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="env" type="RID" />
<argument index="1" name="max_layer" type="int" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<description>
Sets the maximum layer to use if using Canvas background mode.
</description>
</method>
<method name="environment_set_fog">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<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" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<description>
</description>
</method>
<method name="environment_set_glow">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<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" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<description>
</description>
</method>
<method name="environment_set_sdfgi">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="env" type="RID" />
<argument index="1" name="enable" type="bool" />
<argument index="2" name="cascades" type="int" enum="RenderingServer.EnvironmentSDFGICascades" />
<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" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<description>
</description>
</method>
<method name="environment_set_sdfgi_frames_to_converge">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="frames" type="int" enum="RenderingServer.EnvironmentSDFGIFramesToConverge" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<description>
</description>
</method>
<method name="environment_set_sdfgi_frames_to_update_light">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="frames" type="int" enum="RenderingServer.EnvironmentSDFGIFramesToUpdateLight" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<description>
</description>
</method>
<method name="environment_set_sdfgi_ray_count">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="ray_count" type="int" enum="RenderingServer.EnvironmentSDFGIRayCount" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<description>
</description>
</method>
<method name="environment_set_sky">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="env" type="RID" />
<argument index="1" name="sky" type="RID" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<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">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="env" type="RID" />
<argument index="1" name="scale" type="float" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<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">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="env" type="RID" />
<argument index="1" name="orientation" type="Basis" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<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">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<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" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<description>
Sets the variables to be used with the "screen space ambient occlusion" post-process effect. See [Environment] for more details.
</description>
</method>
<method name="environment_set_ssao_quality">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<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" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<description>
</description>
</method>
<method name="environment_set_ssr">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<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" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<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">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="quality" type="int" enum="RenderingServer.EnvironmentSSRRoughnessQuality" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<description>
</description>
</method>
<method name="environment_set_tonemap">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<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" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<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">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="env" type="RID" />
<argument index="1" name="enable" type="bool" />
<argument index="2" name="density" type="float" />
Addition of FogVolumes, FogShaders, FogMaterial, and overhaul of VolumetricFog Co-authored-by: Brian Semrau <brian.semrau@gmail.com>
2021-10-03 13:28:55 +02:00
<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" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<description>
</description>
</method>
<method name="environment_set_volumetric_fog_filter_active">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="active" type="bool" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<description>
Addition of FogVolumes, FogShaders, FogMaterial, and overhaul of VolumetricFog Co-authored-by: Brian Semrau <brian.semrau@gmail.com>
2021-10-03 13:28:55 +02:00
Enables filtering of the volumetric fog scattering buffer. This results in much smoother volumes with very few under-sampling artifacts.
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
</description>
</method>
<method name="environment_set_volumetric_fog_volume_size">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="size" type="int" />
<argument index="1" name="depth" type="int" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<description>
Addition of FogVolumes, FogShaders, FogMaterial, and overhaul of VolumetricFog Co-authored-by: Brian Semrau <brian.semrau@gmail.com>
2021-10-03 13:28:55 +02:00
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.
</description>
</method>
<method name="fog_volume_create">
<return type="RID" />
<description>
Creates a new fog volume and allocates an RID.
</description>
</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" />
<description>
Sets the size of the fog volume when shape is [constant FOG_VOLUME_SHAPE_ELLIPSOID] or [constant 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" />
<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" />
<description>
Sets the shape of the fog volume to either [constant RenderingServer.FOG_VOLUME_SHAPE_ELLIPSOID], [constant RenderingServer.FOG_VOLUME_SHAPE_BOX], or [constant RenderingServer.FOG_VOLUME_SHAPE_ELLIPSOID] or [constant RenderingServer.FOG_VOLUME_SHAPE_WORLD].
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
</description>
</method>
<method name="force_draw">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="swap_buffers" type="bool" default="true" />
<argument index="1" name="frame_step" type="float" default="0.0" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<description>
</description>
</method>
<method name="force_sync">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<description>
</description>
</method>
<method name="free_rid">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="rid" type="RID" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<description>
Tries to free an object in the RenderingServer.
</description>
</method>
<method name="get_frame_setup_time_cpu" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="float" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<description>
</description>
</method>
Expose Vulkan internal values for access from extensions
2021-08-29 04:52:19 +02:00
<method name="get_rendering_device" qualifiers="const">
<return type="RenderingDevice" />
<description>
</description>
</method>
Fix Render Info * Fixed and redone the process to obtain render information from a viewport * Some stats, such as material changes are too difficult to guess on Vulkan, were removed. * Separated visible and shadow stats, which causes confusion. * Texture, buffer and general video memory can be queried now. * Fixed the performance metrics too.
2021-07-03 01:14:19 +02:00
<method name="get_rendering_info">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="int" />
<argument index="0" name="info" type="int" enum="RenderingServer.RenderingInfo" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<description>
</description>
</method>
<method name="get_test_cube">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="RID" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<description>
Returns the id of the test cube. Creates one if none exists.
</description>
</method>
<method name="get_test_texture">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="RID" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<description>
Returns the id of the test texture. Creates one if none exists.
</description>
</method>
<method name="get_video_adapter_name" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="String" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<description>
Returns the name of the video adapter (e.g. "GeForce GTX 1080/PCIe/SSE2").
[b]Note:[/b] When running a headless or server binary, this function returns an empty string.
</description>
</method>
<method name="get_video_adapter_vendor" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="String" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<description>
Returns the vendor of the video adapter (e.g. "NVIDIA Corporation").
[b]Note:[/b] When running a headless or server binary, this function returns an empty string.
</description>
</method>
<method name="get_white_texture">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="RID" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<description>
Returns the id of a white texture. Creates one if none exists.
</description>
</method>
<method name="global_variable_add">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<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" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<description>
</description>
</method>
<method name="global_variable_get" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="Variant" />
<argument index="0" name="name" type="StringName" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<description>
</description>
</method>
<method name="global_variable_get_list" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="PackedStringArray" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<description>
</description>
</method>
<method name="global_variable_get_type" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="int" enum="RenderingServer.GlobalVariableType" />
<argument index="0" name="name" type="StringName" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<description>
</description>
</method>
<method name="global_variable_remove">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="name" type="StringName" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<description>
</description>
</method>
<method name="global_variable_set">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="name" type="StringName" />
<argument index="1" name="value" type="Variant" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<description>
</description>
</method>
<method name="global_variable_set_override">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="name" type="StringName" />
<argument index="1" name="value" type="Variant" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<description>
</description>
</method>
<method name="has_changed" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="bool" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<description>
Returns [code]true[/code] if changes have been made to the RenderingServer's data. [method force_draw] is usually called if this happens.
</description>
</method>
<method name="has_feature" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="bool" />
<argument index="0" name="feature" type="int" enum="RenderingServer.Features" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<description>
Not yet implemented. Always returns [code]false[/code].
</description>
</method>
<method name="has_os_feature" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="bool" />
<argument index="0" name="feature" type="String" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<description>
Returns [code]true[/code] if the OS supports a certain feature. Features might be [code]s3tc[/code], [code]etc[/code], [code]etc2[/code] and [code]pvrtc[/code].
</description>
</method>
<method name="instance_attach_object_instance_id">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="instance" type="RID" />
<argument index="1" name="id" type="int" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<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">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="instance" type="RID" />
<argument index="1" name="skeleton" type="RID" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<description>
Attaches a skeleton to an instance. Removes the previous skeleton from the instance.
</description>
</method>
<method name="instance_create">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="RID" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<description>
Creates a visual instance and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all [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.
An instance is a way of placing a 3D object in the scenario. Objects like particles, meshes, and reflection probes need to be associated with an instance to be visible in the scenario using [method instance_set_base].
</description>
</method>
<method name="instance_create2">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="RID" />
<argument index="0" name="base" type="RID" />
<argument index="1" name="scenario" type="RID" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<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.
</description>
</method>
<method name="instance_geometry_get_shader_parameter" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="Variant" />
<argument index="0" name="instance" type="RID" />
<argument index="1" name="parameter" type="StringName" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<description>
</description>
</method>
<method name="instance_geometry_get_shader_parameter_default_value" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="Variant" />
<argument index="0" name="instance" type="RID" />
<argument index="1" name="parameter" type="StringName" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<description>
</description>
</method>
<method name="instance_geometry_get_shader_parameter_list" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="Array" />
<argument index="0" name="instance" type="RID" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<description>
</description>
</method>
<method name="instance_geometry_set_cast_shadows_setting">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="instance" type="RID" />
<argument index="1" name="shadow_casting_setting" type="int" enum="RenderingServer.ShadowCastingSetting" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<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">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<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" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<description>
Sets the flag for a given [enum InstanceFlags]. See [enum InstanceFlags] for more details.
</description>
</method>
<method name="instance_geometry_set_lightmap">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<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" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<description>
</description>
</method>
<method name="instance_geometry_set_lod_bias">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="instance" type="RID" />
<argument index="1" name="lod_bias" type="float" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<description>
</description>
</method>
<method name="instance_geometry_set_material_override">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="instance" type="RID" />
<argument index="1" name="material" type="RID" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<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">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="instance" type="RID" />
<argument index="1" name="parameter" type="StringName" />
<argument index="2" name="value" type="Variant" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
</description>
</method>
Implement distance fade and transparency The built-in ALPHA in spatial shaders comes pre-set with a per-instance transparency value. Multiply by it if you want to keep it. The transparency value of any given GeometryInstance3D is affected by: - Its new "transparency" property. - Its own visiblity range when the new "visibility_range_fade_mode" property is set to "Self". - Its parent visibility range when the parent's fade mode is set to "Dependencies". The "Self" mode will fade-out the instance when reaching the visibility range limits, while the "Dependencies" mode will fade-in its dependencies. Per-instance transparency is only implemented in the forward clustered renderer, support for mobile should be added in the future. Co-authored-by: reduz <reduzio@gmail.com>
2021-07-20 20:17:34 +02:00
<method name="instance_geometry_set_transparency">
<return type="void" />
<argument index="0" name="instance" type="RID" />
<argument index="1" name="transparency" type="float" />
<description>
Sets the transparency for the given geometry instance. Equivalent to [member GeometryInstance3D.transparency].
</description>
</method>
Implement visibility range and dependencies. This commit adds the following properties to GeometryInstance3D: `visibility_range_begin`, `visibility_range_begin_margin`, `visibility_range_end`, `visibility_range_end_margin`. Together they define a range in which the GeometryInstance3D will be visible from the camera, taking hysteresis into account for state changes. A begin or end value of 0 will be ignored, so the visibility range can be open-ended in both directions. This commit also adds the `visibility_parent` property to 'Node3D'. Which defines the visibility parents of the node and its subtree (until another parent is defined). Visual instances with a visibility parent will only be visible when the parent, and all of its ancestors recursively, are hidden because they are closer to the camera than their respective `visibility_range_begin` thresholds. Combining visibility ranges and visibility parents users can set-up a quick HLOD system that shows high detail meshes when close (i.e buildings, trees) and merged low detail meshes for far away groups (i.e. cities, woods).
2021-05-09 18:23:20 +02:00
<method name="instance_geometry_set_visibility_range">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<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" />
Implement distance fade and transparency The built-in ALPHA in spatial shaders comes pre-set with a per-instance transparency value. Multiply by it if you want to keep it. The transparency value of any given GeometryInstance3D is affected by: - Its new "transparency" property. - Its own visiblity range when the new "visibility_range_fade_mode" property is set to "Self". - Its parent visibility range when the parent's fade mode is set to "Dependencies". The "Self" mode will fade-out the instance when reaching the visibility range limits, while the "Dependencies" mode will fade-in its dependencies. Per-instance transparency is only implemented in the forward clustered renderer, support for mobile should be added in the future. Co-authored-by: reduz <reduzio@gmail.com>
2021-07-20 20:17:34 +02:00
<argument index="5" name="fade_mode" type="int" enum="RenderingServer.VisibilityRangeFadeMode" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<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">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="instance" type="RID" />
<argument index="1" name="base" type="RID" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<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">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="instance" type="RID" />
<argument index="1" name="shape" type="int" />
<argument index="2" name="weight" type="float" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<description>
Sets the weight for a given blend shape associated with this instance.
</description>
</method>
<method name="instance_set_custom_aabb">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="instance" type="RID" />
<argument index="1" name="aabb" type="AABB" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<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">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="instance" type="RID" />
<argument index="1" name="margin" type="float" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<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>
Addition of FogVolumes, FogShaders, FogMaterial, and overhaul of VolumetricFog Co-authored-by: Brian Semrau <brian.semrau@gmail.com>
2021-10-03 13:28:55 +02:00
<method name="instance_set_ignore_culling">
<return type="void" />
<argument index="0" name="instance" type="RID" />
<argument index="1" name="enabled" type="bool" />
<description>
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="instance_set_layer_mask">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="instance" type="RID" />
<argument index="1" name="mask" type="int" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<description>
Sets the render layers that this instance will be drawn to. Equivalent to [member VisualInstance3D.layers].
</description>
</method>
<method name="instance_set_scenario">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="instance" type="RID" />
<argument index="1" name="scenario" type="RID" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<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">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="instance" type="RID" />
<argument index="1" name="surface" type="int" />
<argument index="2" name="material" type="RID" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<description>
Sets the override material of a specific surface. Equivalent to [method MeshInstance3D.set_surface_override_material].
</description>
</method>
<method name="instance_set_transform">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="instance" type="RID" />
<argument index="1" name="transform" type="Transform3D" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<description>
Sets the world space transform of the instance. Equivalent to [member Node3D.transform].
</description>
</method>
<method name="instance_set_visibility_parent">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="instance" type="RID" />
<argument index="1" name="parent" type="RID" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<description>
Sets the visibility parent for the given instance. Equivalent to [member Node3D.visibility_parent].
</description>
</method>
<method name="instance_set_visible">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="instance" type="RID" />
<argument index="1" name="visible" type="bool" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<description>
Sets whether an instance is drawn or not. Equivalent to [member Node3D.visible].
</description>
</method>
<method name="instances_cull_aabb" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="Array" />
<argument index="0" name="aabb" type="AABB" />
<argument index="1" name="scenario" type="RID" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<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">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="Array" />
<argument index="0" name="convex" type="Array" />
<argument index="1" name="scenario" type="RID" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<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">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="Array" />
<argument index="0" name="from" type="Vector3" />
<argument index="1" name="to" type="Vector3" />
<argument index="2" name="scenario" type="RID" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<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.
</description>
</method>
<method name="light_directional_set_blend_splits">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="light" type="RID" />
<argument index="1" name="enable" type="bool" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<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">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="light" type="RID" />
<argument index="1" name="mode" type="int" enum="RenderingServer.LightDirectionalShadowMode" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<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_only">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="light" type="RID" />
<argument index="1" name="enable" type="bool" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<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">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="light" type="RID" />
<argument index="1" name="mode" type="int" enum="RenderingServer.LightOmniShadowMode" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<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>
Implement more rendering options as specialization constants * Shadow quality settings now specialization constant. * Decal and light projector filters can be set. * Changing those settings forces re-creation of the pipelines. These changes should help improve performance related to shadow mapping, and allows improving performance by sacrificing decal and light projector quality.
2021-07-19 21:41:55 +02:00
<method name="light_projectors_set_filter">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="filter" type="int" enum="RenderingServer.LightProjectorFilter" />
Implement more rendering options as specialization constants * Shadow quality settings now specialization constant. * Decal and light projector filters can be set. * Changing those settings forces re-creation of the pipelines. These changes should help improve performance related to shadow mapping, and allows improving performance by sacrificing decal and light projector quality.
2021-07-19 21:41:55 +02:00
<description>
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="light_set_bake_mode">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="light" type="RID" />
<argument index="1" name="bake_mode" type="int" enum="RenderingServer.LightBakeMode" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<description>
</description>
</method>
<method name="light_set_color">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="light" type="RID" />
<argument index="1" name="color" type="Color" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<description>
Sets the color of the light. Equivalent to [member Light3D.light_color].
</description>
</method>
<method name="light_set_cull_mask">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="light" type="RID" />
<argument index="1" name="mask" type="int" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<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_max_sdfgi_cascade">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="light" type="RID" />
<argument index="1" name="cascade" type="int" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<description>
</description>
</method>
<method name="light_set_negative">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="light" type="RID" />
<argument index="1" name="enable" type="bool" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<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">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<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" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<description>
Sets the specified light parameter. See [enum LightParam] for options. Equivalent to [method Light3D.set_param].
</description>
</method>
<method name="light_set_projector">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="light" type="RID" />
<argument index="1" name="texture" type="RID" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<description>
Not implemented in Godot 3.x.
</description>
</method>
<method name="light_set_reverse_cull_face_mode">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="light" type="RID" />
<argument index="1" name="enabled" type="bool" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<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">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="light" type="RID" />
<argument index="1" name="enabled" type="bool" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<description>
If [code]true[/code], light will cast shadows. Equivalent to [member Light3D.shadow_enabled].
</description>
</method>
<method name="light_set_shadow_color">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="light" type="RID" />
<argument index="1" name="color" type="Color" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<description>
Sets the color of the shadow cast by the light. Equivalent to [member Light3D.shadow_color].
</description>
</method>
<method name="lightmap_create">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="RID" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<description>
</description>
</method>
<method name="lightmap_get_probe_capture_bsp_tree" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="PackedInt32Array" />
<argument index="0" name="lightmap" type="RID" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<description>
</description>
</method>
<method name="lightmap_get_probe_capture_points" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="PackedVector3Array" />
<argument index="0" name="lightmap" type="RID" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<description>
</description>
</method>
<method name="lightmap_get_probe_capture_sh" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="PackedColorArray" />
<argument index="0" name="lightmap" type="RID" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<description>
</description>
</method>
<method name="lightmap_get_probe_capture_tetrahedra" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="PackedInt32Array" />
<argument index="0" name="lightmap" type="RID" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<description>
</description>
</method>
<method name="lightmap_set_probe_bounds">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="lightmap" type="RID" />
<argument index="1" name="bounds" type="AABB" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<description>
</description>
</method>
<method name="lightmap_set_probe_capture_data">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<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" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<description>
</description>
</method>
<method name="lightmap_set_probe_capture_update_speed">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="speed" type="float" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<description>
</description>
</method>
<method name="lightmap_set_probe_interior">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="lightmap" type="RID" />
<argument index="1" name="interior" type="bool" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<description>
</description>
</method>
<method name="lightmap_set_textures">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<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" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<description>
</description>
</method>
<method name="make_sphere_mesh">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="RID" />
<argument index="0" name="latitudes" type="int" />
<argument index="1" name="longitudes" type="int" />
<argument index="2" name="radius" type="float" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<description>
Returns a mesh of a sphere with the given amount of horizontal and vertical subdivisions.
</description>
</method>
<method name="material_create">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="RID" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<description>
Creates an empty material and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all [code]material_*[/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="material_get_param" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="Variant" />
<argument index="0" name="material" type="RID" />
<argument index="1" name="parameter" type="StringName" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<description>
Returns the value of a certain material's parameter.
</description>
</method>
<method name="material_set_next_pass">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="material" type="RID" />
<argument index="1" name="next_material" type="RID" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<description>
Sets an object's next material.
</description>
</method>
<method name="material_set_param">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="material" type="RID" />
<argument index="1" name="parameter" type="StringName" />
<argument index="2" name="value" type="Variant" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<description>
Sets a material's parameter.
</description>
</method>
<method name="material_set_render_priority">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="material" type="RID" />
<argument index="1" name="priority" type="int" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<description>
Sets a material's render priority.
</description>
</method>
<method name="material_set_shader">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="shader_material" type="RID" />
<argument index="1" name="shader" type="RID" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<description>
Sets a shader material's shader.
</description>
</method>
<method name="mesh_add_surface">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="mesh" type="RID" />
<argument index="1" name="surface" type="Dictionary" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<description>
</description>
</method>
<method name="mesh_add_surface_from_arrays">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<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="[]" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<argument index="4" name="lods" type="Dictionary" default="{
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
}" />
<argument index="5" name="compress_format" type="int" default="0" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<description>
</description>
</method>
<method name="mesh_clear">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="mesh" type="RID" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<description>
Removes all surfaces from a mesh.
</description>
</method>
<method name="mesh_create">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="RID" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<description>
Creates a new mesh and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all [code]mesh_*[/code] RenderingServer functions.
Once finished with your RID, you will want to free the RID using the RenderingServer's [method free_rid] static method.
To place in a scene, attach this mesh to an instance using [method instance_set_base] using the returned RID.
</description>
</method>
<method name="mesh_create_from_surfaces">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="RID" />
<argument index="0" name="surfaces" type="Dictionary[]" />
<argument index="1" name="blend_shape_count" type="int" default="0" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<description>
</description>
</method>
<method name="mesh_get_blend_shape_count" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="int" />
<argument index="0" name="mesh" type="RID" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<description>
Returns a mesh's blend shape count.
</description>
</method>
<method name="mesh_get_blend_shape_mode" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="int" enum="RenderingServer.BlendShapeMode" />
<argument index="0" name="mesh" type="RID" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<description>
Returns a mesh's blend shape mode.
</description>
</method>
<method name="mesh_get_custom_aabb" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="AABB" />
<argument index="0" name="mesh" type="RID" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<description>
Returns a mesh's custom aabb.
</description>
</method>
<method name="mesh_get_surface">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="Dictionary" />
<argument index="0" name="mesh" type="RID" />
<argument index="1" name="surface" type="int" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<description>
</description>
</method>
<method name="mesh_get_surface_count" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="int" />
<argument index="0" name="mesh" type="RID" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<description>
Returns a mesh's number of surfaces.
</description>
</method>
<method name="mesh_set_blend_shape_mode">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="mesh" type="RID" />
<argument index="1" name="mode" type="int" enum="RenderingServer.BlendShapeMode" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<description>
Sets a mesh's blend shape mode.
</description>
</method>
<method name="mesh_set_custom_aabb">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="mesh" type="RID" />
<argument index="1" name="aabb" type="AABB" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<description>
Sets a mesh's custom aabb.
</description>
</method>
<method name="mesh_set_shadow_mesh">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="mesh" type="RID" />
<argument index="1" name="shadow_mesh" type="RID" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<description>
</description>
</method>
<method name="mesh_surface_get_arrays" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="Array" />
<argument index="0" name="mesh" type="RID" />
<argument index="1" name="surface" type="int" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<description>
Returns a mesh's surface's buffer arrays.
</description>
</method>
<method name="mesh_surface_get_blend_shape_arrays" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="Array" />
<argument index="0" name="mesh" type="RID" />
<argument index="1" name="surface" type="int" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<description>
Returns a mesh's surface's arrays for blend shapes.
</description>
</method>
<method name="mesh_surface_get_format_attribute_stride" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="int" />
<argument index="0" name="format" type="int" />
<argument index="1" name="vertex_count" type="int" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<description>
</description>
</method>
<method name="mesh_surface_get_format_offset" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<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" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<description>
</description>
</method>
<method name="mesh_surface_get_format_skin_stride" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="int" />
<argument index="0" name="format" type="int" />
<argument index="1" name="vertex_count" type="int" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<description>
</description>
</method>
<method name="mesh_surface_get_format_vertex_stride" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="int" />
<argument index="0" name="format" type="int" />
<argument index="1" name="vertex_count" type="int" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<description>
</description>
</method>
<method name="mesh_surface_get_material" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="RID" />
<argument index="0" name="mesh" type="RID" />
<argument index="1" name="surface" type="int" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<description>
Returns a mesh's surface's material.
</description>
</method>
<method name="mesh_surface_set_material">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="mesh" type="RID" />
<argument index="1" name="surface" type="int" />
<argument index="2" name="material" type="RID" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<description>
Sets a mesh's surface's material.
</description>
</method>
<method name="mesh_surface_update_attribute_region">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<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" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<description>
</description>
</method>
<method name="mesh_surface_update_skin_region">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<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" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<description>
</description>
</method>
<method name="mesh_surface_update_vertex_region">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<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" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<description>
</description>
</method>
<method name="multimesh_allocate_data">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<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" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<description>
</description>
</method>
<method name="multimesh_create">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="RID" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<description>
Creates a new multimesh on the RenderingServer and returns an [RID] handle. This RID will be used in all [code]multimesh_*[/code] RenderingServer functions.
Once finished with your RID, you will want to free the RID using the RenderingServer's [method free_rid] static method.
To place in a scene, attach this multimesh to an instance using [method instance_set_base] using the returned RID.
</description>
</method>
<method name="multimesh_get_aabb" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="AABB" />
<argument index="0" name="multimesh" type="RID" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<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">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="PackedFloat32Array" />
<argument index="0" name="multimesh" type="RID" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<description>
</description>
</method>
<method name="multimesh_get_instance_count" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="int" />
<argument index="0" name="multimesh" type="RID" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<description>
Returns the number of instances allocated for this multimesh.
</description>
</method>
<method name="multimesh_get_mesh" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="RID" />
<argument index="0" name="multimesh" type="RID" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<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">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="int" />
<argument index="0" name="multimesh" type="RID" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<description>
Returns the number of visible instances for this multimesh.
</description>
</method>
<method name="multimesh_instance_get_color" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="Color" />
<argument index="0" name="multimesh" type="RID" />
<argument index="1" name="index" type="int" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<description>
Returns the color by which the specified instance will be modulated.
</description>
</method>
<method name="multimesh_instance_get_custom_data" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="Color" />
<argument index="0" name="multimesh" type="RID" />
<argument index="1" name="index" type="int" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<description>
Returns the custom data associated with the specified instance.
</description>
</method>
<method name="multimesh_instance_get_transform" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="Transform3D" />
<argument index="0" name="multimesh" type="RID" />
<argument index="1" name="index" type="int" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
Returns the [Transform3D] of the specified instance.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="multimesh_instance_get_transform_2d" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="Transform2D" />
<argument index="0" name="multimesh" type="RID" />
<argument index="1" name="index" type="int" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
Returns the [Transform2D] of the specified instance. For use when the multimesh is set to use 2D transforms.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="multimesh_instance_set_color">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="multimesh" type="RID" />
<argument index="1" name="index" type="int" />
<argument index="2" name="color" type="Color" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
Sets the color by which this instance will be modulated. Equivalent to [method MultiMesh.set_instance_color].
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="multimesh_instance_set_custom_data">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<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" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
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].
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="multimesh_instance_set_transform">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="multimesh" type="RID" />
<argument index="1" name="index" type="int" />
<argument index="2" name="transform" type="Transform3D" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
Sets the [Transform3D] for this instance. Equivalent to [method MultiMesh.set_instance_transform].
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="multimesh_instance_set_transform_2d">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="multimesh" type="RID" />
<argument index="1" name="index" type="int" />
<argument index="2" name="transform" type="Transform2D" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
Sets the [Transform2D] for this instance. For use when multimesh is used in 2D. Equivalent to [method MultiMesh.set_instance_transform_2d].
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="multimesh_set_buffer">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="multimesh" type="RID" />
<argument index="1" name="buffer" type="PackedFloat32Array" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="multimesh_set_mesh">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="multimesh" type="RID" />
<argument index="1" name="mesh" type="RID" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
Sets the mesh to be drawn by the multimesh. Equivalent to [member MultiMesh.mesh].
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="multimesh_set_visible_instances">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="multimesh" type="RID" />
<argument index="1" name="visible" type="int" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
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].
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="occluder_create">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="RID" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="occluder_set_mesh">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="occluder" type="RID" />
<argument index="1" name="vertices" type="PackedVector3Array" />
<argument index="2" name="indices" type="PackedInt32Array" />
Implement visibility range and dependencies. This commit adds the following properties to GeometryInstance3D: `visibility_range_begin`, `visibility_range_begin_margin`, `visibility_range_end`, `visibility_range_end_margin`. Together they define a range in which the GeometryInstance3D will be visible from the camera, taking hysteresis into account for state changes. A begin or end value of 0 will be ignored, so the visibility range can be open-ended in both directions. This commit also adds the `visibility_parent` property to 'Node3D'. Which defines the visibility parents of the node and its subtree (until another parent is defined). Visual instances with a visibility parent will only be visible when the parent, and all of its ancestors recursively, are hidden because they are closer to the camera than their respective `visibility_range_begin` thresholds. Combining visibility ranges and visibility parents users can set-up a quick HLOD system that shows high detail meshes when close (i.e buildings, trees) and merged low detail meshes for far away groups (i.e. cities, woods).
2021-05-09 18:23:20 +02:00
<description>
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="omni_light_create">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="RID" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
Creates a new omni light and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID can be used in most [code]light_*[/code] RenderingServer functions.
Once finished with your RID, you will want to free the RID using the RenderingServer's [method free_rid] static method.
To place in a scene, attach this omni light to an instance using [method instance_set_base] using the returned RID.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="particles_collision_create">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="RID" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="particles_collision_height_field_update">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="particles_collision" type="RID" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="particles_collision_set_attractor_attenuation">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="particles_collision" type="RID" />
<argument index="1" name="curve" type="float" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="particles_collision_set_attractor_directionality">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="particles_collision" type="RID" />
<argument index="1" name="amount" type="float" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="particles_collision_set_attractor_strength">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="particles_collision" type="RID" />
<argument index="1" name="setrngth" type="float" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="particles_collision_set_box_extents">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="particles_collision" type="RID" />
<argument index="1" name="extents" type="Vector3" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="particles_collision_set_collision_type">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="particles_collision" type="RID" />
<argument index="1" name="type" type="int" enum="RenderingServer.ParticlesCollisionType" />
Add sky_only setting to DirectionalLight3Ds
2020-10-22 08:22:53 +02:00
<description>
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="particles_collision_set_cull_mask">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="particles_collision" type="RID" />
<argument index="1" name="mask" type="int" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="particles_collision_set_field_texture">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="particles_collision" type="RID" />
<argument index="1" name="texture" type="RID" />
Environment: Refactor code for readability + more - Makes all boolean setters/getters consistent. - Fixes bug where `glow_hdr_bleed_scale` was not used. - Split CameraEffects to their own source file. - Reorder all Environment method and properties declarations, definitions and bindings to be consistent with each other and with the order of property bindings. - Bind missing enum values added with SDFGI. - Remove unused SDFGI enhance_ssr boolean. - Sync doc changes after SDFGI merge and other misc changes.
2020-07-01 14:18:13 +02:00
<description>
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="particles_collision_set_height_field_resolution">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="particles_collision" type="RID" />
<argument index="1" name="resolution" type="int" enum="RenderingServer.ParticlesCollisionHeightfieldResolution" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="particles_collision_set_sphere_radius">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="particles_collision" type="RID" />
<argument index="1" name="radius" type="float" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="particles_create">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="RID" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
Creates a particle system and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all [code]particles_*[/code] RenderingServer functions.
Once finished with your RID, you will want to free the RID using the RenderingServer's [method free_rid] static method.
To place in a scene, attach these particles to an instance using [method instance_set_base] using the returned RID.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="particles_emit">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<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" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="particles_get_current_aabb">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="AABB" />
<argument index="0" name="particles" type="RID" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
Calculates and returns the axis-aligned bounding box that contains all the particles. Equivalent to [method GPUParticles3D.capture_aabb].
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="particles_get_emitting">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="bool" />
<argument index="0" name="particles" type="RID" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<description>
Returns [code]true[/code] if particles are currently set to emitting.
</description>
</method>
<method name="particles_is_inactive">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="bool" />
<argument index="0" name="particles" type="RID" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
Returns [code]true[/code] if particles are not emitting and particles are set to inactive.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="particles_request_process">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="particles" type="RID" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
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].
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="particles_restart">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="particles" type="RID" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
Reset the particles on the next update. Equivalent to [method GPUParticles3D.restart].
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="particles_set_amount">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="particles" type="RID" />
<argument index="1" name="amount" type="int" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
Sets the number of particles to be drawn and allocates the memory for them. Equivalent to [member GPUParticles3D.amount].
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="particles_set_collision_base_size">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="particles" type="RID" />
<argument index="1" name="size" type="float" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="particles_set_custom_aabb">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="particles" type="RID" />
<argument index="1" name="aabb" type="AABB" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
Sets a custom axis-aligned bounding box for the particle system. Equivalent to [member GPUParticles3D.visibility_aabb].
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="particles_set_draw_order">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="particles" type="RID" />
<argument index="1" name="order" type="int" enum="RenderingServer.ParticlesDrawOrder" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
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].
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="particles_set_draw_pass_mesh">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="particles" type="RID" />
<argument index="1" name="pass" type="int" />
<argument index="2" name="mesh" type="RID" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
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].
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="particles_set_draw_passes">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="particles" type="RID" />
<argument index="1" name="count" type="int" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
Sets the number of draw passes to use. Equivalent to [member GPUParticles3D.draw_passes].
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="particles_set_emission_transform">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="particles" type="RID" />
<argument index="1" name="transform" type="Transform3D" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
Sets the [Transform3D] that will be used by the particles when they first emit.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="particles_set_emitting">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="particles" type="RID" />
<argument index="1" name="emitting" type="bool" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
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].
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="particles_set_explosiveness_ratio">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="particles" type="RID" />
<argument index="1" name="ratio" type="float" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
Sets the explosiveness ratio. Equivalent to [member GPUParticles3D.explosiveness].
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="particles_set_fixed_fps">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="particles" type="RID" />
<argument index="1" name="fps" type="int" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
Sets the frame rate that the particle system rendering will be fixed to. Equivalent to [member GPUParticles3D.fixed_fps].
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="particles_set_fractional_delta">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="particles" type="RID" />
<argument index="1" name="enable" type="bool" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
If [code]true[/code], uses fractional delta which smooths the movement of the particles. Equivalent to [member GPUParticles3D.fract_delta].
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="particles_set_interpolate">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="particles" type="RID" />
<argument index="1" name="enable" type="bool" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="particles_set_lifetime">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="particles" type="RID" />
<argument index="1" name="lifetime" type="float" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
Sets the lifetime of each particle in the system. Equivalent to [member GPUParticles3D.lifetime].
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="particles_set_mode">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="particles" type="RID" />
<argument index="1" name="mode" type="int" enum="RenderingServer.ParticlesMode" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="particles_set_one_shot">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="particles" type="RID" />
<argument index="1" name="one_shot" type="bool" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
If [code]true[/code], particles will emit once and then stop. Equivalent to [member GPUParticles3D.one_shot].
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="particles_set_pre_process_time">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="particles" type="RID" />
<argument index="1" name="time" type="float" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
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].
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="particles_set_process_material">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="particles" type="RID" />
<argument index="1" name="material" type="RID" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
doc: Fix style inconsistencies for `[b]Note:[/b]` paragraphs And fix up formatting not supported by makerst.
2021-10-05 14:24:34 +02:00
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].
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="particles_set_randomness_ratio">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="particles" type="RID" />
<argument index="1" name="ratio" type="float" />
doc: Sync classref with current source And fixups: - Add missing bindings in RenderingServer - Remove duplicate ArrayMesh enum bindings (they're in Mesh already) - Remove redundant _unhandled_key_input binding in Control (it's in Node already)
2020-12-04 15:54:48 +01:00
<description>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
Sets the emission randomness ratio. This randomizes the emission of particles within their phase. Equivalent to [member GPUParticles3D.randomness].
doc: Sync classref with current source And fixups: - Add missing bindings in RenderingServer - Remove duplicate ArrayMesh enum bindings (they're in Mesh already) - Remove redundant _unhandled_key_input binding in Control (it's in Node already)
2020-12-04 15:54:48 +01:00
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="particles_set_speed_scale">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="particles" type="RID" />
<argument index="1" name="scale" type="float" />
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
<description>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
Sets the speed scale of the particle system. Equivalent to [member GPUParticles3D.speed_scale].
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="particles_set_subemitter">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="particles" type="RID" />
<argument index="1" name="subemitter_particles" type="RID" />
doc: Sync classref with current source And fixups: - Add missing bindings in RenderingServer - Remove duplicate ArrayMesh enum bindings (they're in Mesh already) - Remove redundant _unhandled_key_input binding in Control (it's in Node already)
2020-12-04 15:54:48 +01:00
<description>
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="particles_set_trail_bind_poses">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="particles" type="RID" />
<argument index="1" name="bind_poses" type="Transform3D[]" />
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
<description>
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="particles_set_trails">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<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" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="particles_set_transform_align">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="particles" type="RID" />
<argument index="1" name="align" type="int" enum="RenderingServer.ParticlesTransformAlign" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="particles_set_use_local_coordinates">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="particles" type="RID" />
<argument index="1" name="enable" type="bool" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
If [code]true[/code], particles use local coordinates. If [code]false[/code] they use global coordinates. Equivalent to [member GPUParticles3D.local_coords].
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="reflection_probe_create">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="RID" />
Added method binding for `multimesh_create` that was missing from VisualServer class.
2019-12-01 06:47:16 +01:00
<description>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
Creates a reflection probe and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all [code]reflection_probe_*[/code] RenderingServer functions.
doc: Update classref with node renames A few extra renames for classes which were missed in last week's PRs.
2020-03-30 18:22:57 +02:00
Once finished with your RID, you will want to free the RID using the RenderingServer's [method free_rid] static method.
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
To place in a scene, attach this reflection probe to an instance using [method instance_set_base] using the returned RID.
Added method binding for `multimesh_create` that was missing from VisualServer class.
2019-12-01 06:47:16 +01:00
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="reflection_probe_set_ambient_color">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="probe" type="RID" />
<argument index="1" name="color" type="Color" />
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 09:59:06 +01:00
<description>
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="reflection_probe_set_ambient_energy">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="probe" type="RID" />
<argument index="1" name="energy" type="float" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="reflection_probe_set_ambient_mode">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="probe" type="RID" />
<argument index="1" name="mode" type="int" enum="RenderingServer.ReflectionProbeAmbientMode" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="reflection_probe_set_as_interior">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="probe" type="RID" />
<argument index="1" name="enable" type="bool" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
If [code]true[/code], reflections will ignore sky contribution. Equivalent to [member ReflectionProbe.interior].
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="reflection_probe_set_cull_mask">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="probe" type="RID" />
<argument index="1" name="layers" type="int" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
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].
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="reflection_probe_set_enable_box_projection">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="probe" type="RID" />
<argument index="1" name="enable" type="bool" />
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
<description>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
If [code]true[/code], uses box projection. This can make reflections look more correct in certain situations. Equivalent to [member ReflectionProbe.box_projection].
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="reflection_probe_set_enable_shadows">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="probe" type="RID" />
<argument index="1" name="enable" type="bool" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
If [code]true[/code], computes shadows in the reflection probe. This makes the reflection much slower to compute. Equivalent to [member ReflectionProbe.enable_shadows].
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="reflection_probe_set_extents">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="probe" type="RID" />
<argument index="1" name="extents" type="Vector3" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
Sets the size of the area that the reflection probe will capture. Equivalent to [member ReflectionProbe.extents].
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="reflection_probe_set_intensity">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="probe" type="RID" />
<argument index="1" name="intensity" type="float" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
Sets the intensity of the reflection probe. Intensity modulates the strength of the reflection. Equivalent to [member ReflectionProbe.intensity].
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="reflection_probe_set_lod_threshold">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="probe" type="RID" />
<argument index="1" name="pixels" type="float" />
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
<description>
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="reflection_probe_set_max_distance">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="probe" type="RID" />
<argument index="1" name="distance" type="float" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
Sets the max distance away from the probe an object can be before it is culled. Equivalent to [member ReflectionProbe.max_distance].
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="reflection_probe_set_origin_offset">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="probe" type="RID" />
<argument index="1" name="offset" type="Vector3" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
Sets the origin offset to be used when this reflection probe is in box project mode. Equivalent to [member ReflectionProbe.origin_offset].
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="reflection_probe_set_resolution">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="probe" type="RID" />
<argument index="1" name="resolution" type="int" />
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
<description>
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="reflection_probe_set_update_mode">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="probe" type="RID" />
<argument index="1" name="mode" type="int" enum="RenderingServer.ReflectionProbeUpdateMode" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
Sets how often the reflection probe updates. Can either be once or every frame. See [enum ReflectionProbeUpdateMode] for options.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="request_frame_drawn_callback">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="where" type="Object" />
<argument index="1" name="method" type="StringName" />
<argument index="2" name="userdata" type="Variant" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
Schedules a callback to the corresponding named [code]method[/code] on [code]where[/code] after a frame has been drawn.
The callback method must use only 1 argument which will be called with [code]userdata[/code].
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="scenario_create">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="RID" />
Implement occlusion culling Added an occlusion culling system with support for static occluder meshes. It can be enabled via `Project Settings > Rendering > Occlusion Culling > Use Occlusion Culling`. Occluders are defined via the new `Occluder3D` resource and instanced using the new `OccluderInstance3D` node. The occluders can also be automatically baked from a scene using the built-in editor plugin.
2021-04-20 18:40:24 +02:00
<description>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
Creates a scenario and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all [code]scenario_*[/code] RenderingServer functions.
Once finished with your RID, you will want to free the RID using the RenderingServer's [method free_rid] static method.
The scenario is the 3D world that all the visual instances exist in.
Implement occlusion culling Added an occlusion culling system with support for static occluder meshes. It can be enabled via `Project Settings > Rendering > Occlusion Culling > Use Occlusion Culling`. Occluders are defined via the new `Occluder3D` resource and instanced using the new `OccluderInstance3D` node. The occluders can also be automatically baked from a scene using the built-in editor plugin.
2021-04-20 18:40:24 +02:00
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="scenario_set_camera_effects">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="scenario" type="RID" />
<argument index="1" name="effects" type="RID" />
Implement occlusion culling Added an occlusion culling system with support for static occluder meshes. It can be enabled via `Project Settings > Rendering > Occlusion Culling > Use Occlusion Culling`. Occluders are defined via the new `Occluder3D` resource and instanced using the new `OccluderInstance3D` node. The occluders can also be automatically baked from a scene using the built-in editor plugin.
2021-04-20 18:40:24 +02:00
<description>
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="scenario_set_environment">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="scenario" type="RID" />
<argument index="1" name="environment" type="RID" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
Sets the environment that will be used with this scenario.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="scenario_set_fallback_environment">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="scenario" type="RID" />
<argument index="1" name="environment" type="RID" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
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.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="screen_space_roughness_limiter_set_active">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="enable" type="bool" />
<argument index="1" name="amount" type="float" />
<argument index="2" name="limit" type="float" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="set_boot_image">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<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" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
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.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
doc: Sync classref with current source
2019-11-11 17:25:05 +01:00
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="set_debug_generate_wireframes">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="generate" type="bool" />
doc: Sync classref with current source
2019-11-11 17:25:05 +01:00
<description>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
If [code]true[/code], the engine will generate wireframes for use with the wireframe debug mode.
doc: Sync classref with current source
2019-11-11 17:25:05 +01:00
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="set_default_clear_color">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="color" type="Color" />
doc: Sync classref with current source
2019-11-11 17:25:05 +01:00
<description>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
Sets the default clear color which is used when a specific clear color has not been selected.
doc: Sync classref with current source
2019-11-11 17:25:05 +01:00
</description>
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="shader_create">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="RID" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<description>
Creates an empty shader and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all [code]shader_*[/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="shader_get_code" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="String" />
<argument index="0" name="shader" type="RID" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
Returns a shader's code.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="shader_get_default_texture_param" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="RID" />
<argument index="0" name="shader" type="RID" />
<argument index="1" name="param" type="StringName" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
Returns a default texture from a shader searched by name.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="shader_get_param_default" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="Variant" />
<argument index="0" name="shader" type="RID" />
<argument index="1" name="param" type="StringName" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="shader_get_param_list" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="Dictionary[]" />
<argument index="0" name="shader" type="RID" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
Returns the parameters of a shader.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="shader_set_default_texture_param">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="shader" type="RID" />
<argument index="1" name="param" type="StringName" />
<argument index="2" name="texture" type="RID" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
Sets a shader's default texture. Overwrites the texture given by name.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="shadows_quality_set">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="quality" type="int" enum="RenderingServer.ShadowQuality" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="skeleton_allocate_data">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<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" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="skeleton_bone_get_transform" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="Transform3D" />
<argument index="0" name="skeleton" type="RID" />
<argument index="1" name="bone" type="int" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
Returns the [Transform3D] set for a specific bone of this skeleton.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="skeleton_bone_get_transform_2d" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="Transform2D" />
<argument index="0" name="skeleton" type="RID" />
<argument index="1" name="bone" type="int" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<description>
Returns the [Transform2D] set for a specific bone of this skeleton.
</description>
</method>
<method name="skeleton_bone_set_transform">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="skeleton" type="RID" />
<argument index="1" name="bone" type="int" />
<argument index="2" name="transform" type="Transform3D" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
Sets the [Transform3D] for a specific bone of this skeleton.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="skeleton_bone_set_transform_2d">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="skeleton" type="RID" />
<argument index="1" name="bone" type="int" />
<argument index="2" name="transform" type="Transform2D" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
Sets the [Transform2D] for a specific bone of this skeleton.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="skeleton_create">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="RID" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
Creates a skeleton and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all [code]skeleton_*[/code] RenderingServer functions.
Once finished with your RID, you will want to free the RID using the RenderingServer's [method free_rid] static method.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="skeleton_get_bone_count" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="int" />
<argument index="0" name="skeleton" type="RID" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
Returns the number of bones allocated for this skeleton.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="skeleton_set_base_transform_2d">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="skeleton" type="RID" />
<argument index="1" name="base_transform" type="Transform2D" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="sky_bake_panorama">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<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" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="sky_create">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="RID" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
Creates an empty sky and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all [code]sky_*[/code] RenderingServer functions.
Once finished with your RID, you will want to free the RID using the RenderingServer's [method free_rid] static method.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="sky_set_material">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="sky" type="RID" />
<argument index="1" name="material" type="RID" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
Sets the material that the sky uses to render the background and reflection maps.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="sky_set_mode">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="sky" type="RID" />
<argument index="1" name="mode" type="int" enum="RenderingServer.SkyMode" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="sky_set_radiance_size">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="sky" type="RID" />
<argument index="1" name="radiance_size" type="int" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="spot_light_create">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="RID" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
Creates a spot light and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID can be used in most [code]light_*[/code] RenderingServer functions.
doc: Update classref with node renames A few extra renames for classes which were missed in last week's PRs.
2020-03-30 18:22:57 +02:00
Once finished with your RID, you will want to free the RID using the RenderingServer's [method free_rid] static method.
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
To place in a scene, attach this spot light to an instance using [method instance_set_base] using the returned RID.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="sub_surface_scattering_set_quality">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="quality" type="int" enum="RenderingServer.SubSurfaceScatteringQuality" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="sub_surface_scattering_set_scale">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="scale" type="float" />
<argument index="1" name="depth_scale" type="float" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="texture_2d_create">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="RID" />
<argument index="0" name="image" type="Image" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="texture_2d_get" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="Image" />
<argument index="0" name="texture" type="RID" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="texture_2d_layer_get" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="Image" />
<argument index="0" name="texture" type="RID" />
<argument index="1" name="layer" type="int" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="texture_2d_layered_create">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="RID" />
<argument index="0" name="layers" type="Image[]" />
<argument index="1" name="layered_type" type="int" enum="RenderingServer.TextureLayeredType" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="texture_2d_layered_placeholder_create">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="RID" />
<argument index="0" name="layered_type" type="int" enum="RenderingServer.TextureLayeredType" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="texture_2d_placeholder_create">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="RID" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="texture_2d_update">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="texture" type="RID" />
<argument index="1" name="image" type="Image" />
<argument index="2" name="layer" type="int" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="texture_3d_create">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<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[]" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="texture_3d_get" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="Image[]" />
<argument index="0" name="texture" type="RID" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="texture_3d_placeholder_create">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="RID" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="texture_3d_update">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="texture" type="RID" />
<argument index="1" name="data" type="Image[]" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<description>
</description>
</method>
<method name="texture_get_path" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="String" />
<argument index="0" name="texture" type="RID" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="texture_proxy_create">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="RID" />
<argument index="0" name="base" type="RID" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="texture_proxy_update">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="texture" type="RID" />
<argument index="1" name="proxy_to" type="RID" />
Implement occlusion culling Added an occlusion culling system with support for static occluder meshes. It can be enabled via `Project Settings > Rendering > Occlusion Culling > Use Occlusion Culling`. Occluders are defined via the new `Occluder3D` resource and instanced using the new `OccluderInstance3D` node. The occluders can also be automatically baked from a scene using the built-in editor plugin.
2021-04-20 18:40:24 +02:00
<description>
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="texture_replace">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="texture" type="RID" />
<argument index="1" name="by_texture" type="RID" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="texture_set_force_redraw_if_visible">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="texture" type="RID" />
<argument index="1" name="enable" type="bool" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="texture_set_path">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="texture" type="RID" />
<argument index="1" name="path" type="String" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="texture_set_size_override">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="texture" type="RID" />
<argument index="1" name="width" type="int" />
<argument index="2" name="height" type="int" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<description>
</description>
</method>
<method name="viewport_attach_camera">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="viewport" type="RID" />
<argument index="1" name="camera" type="RID" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
Sets a viewport's camera.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="viewport_attach_canvas">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="viewport" type="RID" />
<argument index="1" name="canvas" type="RID" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
Sets a viewport's canvas.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="viewport_attach_to_screen">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<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" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
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.
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]
[gdscript]
func _ready():
get_viewport().set_attach_to_screen_rect(Rect2())
$Viewport.set_attach_to_screen_rect(Rect2(0, 0, 600, 600))
[/gdscript]
[/codeblocks]
Using this can result in significant optimization, especially on lower-end devices. However, it comes at the cost of having to manage your viewports manually. For a further optimization see, [method viewport_set_render_direct_to_screen].
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="viewport_create">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="RID" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
Creates an empty viewport and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all [code]viewport_*[/code] RenderingServer functions.
doc: Update classref with node renames A few extra renames for classes which were missed in last week's PRs.
2020-03-30 18:22:57 +02:00
Once finished with your RID, you will want to free the RID using the RenderingServer's [method free_rid] static method.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="viewport_get_measured_render_time_cpu" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="float" />
<argument index="0" name="viewport" type="RID" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<description>
</description>
</method>
<method name="viewport_get_measured_render_time_gpu" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="float" />
<argument index="0" name="viewport" type="RID" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="viewport_get_render_info">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<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" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="viewport_get_texture" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="RID" />
<argument index="0" name="viewport" type="RID" />
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 09:59:06 +01:00
<description>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
Returns the viewport's last rendered frame.
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 09:59:06 +01:00
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="viewport_remove_canvas">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="viewport" type="RID" />
<argument index="1" name="canvas" type="RID" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
Detaches a viewport from a canvas and vice versa.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="viewport_set_active">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="viewport" type="RID" />
<argument index="1" name="active" type="bool" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
If [code]true[/code], sets the viewport active, else sets it inactive.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="viewport_set_canvas_stacking">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<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" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
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.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="viewport_set_canvas_transform">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="viewport" type="RID" />
<argument index="1" name="canvas" type="RID" />
<argument index="2" name="offset" type="Transform2D" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
Sets the transformation of a viewport's canvas.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="viewport_set_clear_mode">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="viewport" type="RID" />
<argument index="1" name="clear_mode" type="int" enum="RenderingServer.ViewportClearMode" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
Sets the clear mode of a viewport. See [enum ViewportClearMode] for options.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="viewport_set_debug_draw">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="viewport" type="RID" />
<argument index="1" name="draw" type="int" enum="RenderingServer.ViewportDebugDraw" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
Sets the debug draw mode of a viewport. See [enum ViewportDebugDraw] for options.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="viewport_set_default_canvas_item_texture_filter">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="viewport" type="RID" />
<argument index="1" name="filter" type="int" enum="RenderingServer.CanvasItemTextureFilter" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="viewport_set_default_canvas_item_texture_repeat">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="viewport" type="RID" />
<argument index="1" name="repeat" type="int" enum="RenderingServer.CanvasItemTextureRepeat" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="viewport_set_disable_2d">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="viewport" type="RID" />
<argument index="1" name="disable" type="bool" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
If [code]true[/code], the viewport's canvas is not rendered.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="viewport_set_disable_3d">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="viewport" type="RID" />
<argument index="1" name="disable" type="bool" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="viewport_set_disable_environment">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="viewport" type="RID" />
<argument index="1" name="disabled" type="bool" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
If [code]true[/code], rendering of a viewport's environment is disabled.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="viewport_set_global_canvas_transform">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="viewport" type="RID" />
<argument index="1" name="transform" type="Transform2D" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
Sets the viewport's global transformation matrix.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="viewport_set_measure_render_time">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="viewport" type="RID" />
<argument index="1" name="enable" type="bool" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="viewport_set_msaa">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="viewport" type="RID" />
<argument index="1" name="msaa" type="int" enum="RenderingServer.ViewportMSAA" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
Sets the anti-aliasing mode. See [enum ViewportMSAA] for options.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="viewport_set_occlusion_culling_build_quality">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="quality" type="int" enum="RenderingServer.ViewportOcclusionCullingBuildQuality" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="viewport_set_occlusion_rays_per_thread">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="rays_per_thread" type="int" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="viewport_set_parent_viewport">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="viewport" type="RID" />
<argument index="1" name="parent_viewport" type="RID" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
Sets the viewport's parent to another viewport.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="viewport_set_render_direct_to_screen">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="viewport" type="RID" />
<argument index="1" name="enabled" type="bool" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
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.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</description>
</method>
Optionally scale 3D render content
2021-08-19 03:52:06 +02:00
<method name="viewport_set_scale_3d">
<return type="void" />
<argument index="0" name="viewport" type="RID" />
Allow any floating-point value as a 3D rendering scale option This allows for finer control over 3D rendering resolution. Supersampling can also be performed by setting a 3D rendering resolution above 1.0, which is useful for offline rendering or for very high-end GPUs.
2021-08-29 14:44:09 +02:00
<argument index="1" name="scale" type="float" />
Optionally scale 3D render content
2021-08-19 03:52:06 +02:00
<description>
Sets the scale at which we render 3D contents.
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="viewport_set_scenario">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="viewport" type="RID" />
<argument index="1" name="scenario" type="RID" />
doc: Sync classref with current source
2021-01-04 14:33:44 +01:00
<description>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
Sets a viewport's scenario.
The scenario contains information about environment information, reflection atlas etc.
doc: Sync classref with current source
2021-01-04 14:33:44 +01:00
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="viewport_set_screen_space_aa">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="viewport" type="RID" />
<argument index="1" name="mode" type="int" enum="RenderingServer.ViewportScreenSpaceAA" />
doc: Sync classref with current source
2021-01-04 14:33:44 +01:00
<description>
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="viewport_set_sdf_oversize_and_scale">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<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" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="viewport_set_shadow_atlas_quadrant_subdivision">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="viewport" type="RID" />
<argument index="1" name="quadrant" type="int" />
<argument index="2" name="subdivision" type="int" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
Sets the shadow atlas quadrant's subdivision.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="viewport_set_shadow_atlas_size">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<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" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<description>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
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.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="viewport_set_size">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="viewport" type="RID" />
<argument index="1" name="width" type="int" />
<argument index="2" name="height" type="int" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<description>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
Sets the viewport's width and height.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="viewport_set_snap_2d_transforms_to_pixel">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="viewport" type="RID" />
<argument index="1" name="enabled" type="bool" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<description>
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="viewport_set_snap_2d_vertices_to_pixel">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="viewport" type="RID" />
<argument index="1" name="enabled" type="bool" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<description>
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="viewport_set_transparent_background">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="viewport" type="RID" />
<argument index="1" name="enabled" type="bool" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<description>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
If [code]true[/code], the viewport renders its background as transparent.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="viewport_set_update_mode">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="viewport" type="RID" />
<argument index="1" name="update_mode" type="int" enum="RenderingServer.ViewportUpdateMode" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
Sets when the viewport should be updated. See [enum ViewportUpdateMode] constants for options.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="viewport_set_use_debanding">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="viewport" type="RID" />
<argument index="1" name="enable" type="bool" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="viewport_set_use_occlusion_culling">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="viewport" type="RID" />
<argument index="1" name="enable" type="bool" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="viewport_set_use_xr">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="viewport" type="RID" />
<argument index="1" name="use_xr" type="bool" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
If [code]true[/code], the viewport uses augmented or virtual reality technologies. See [XRInterface].
</description>
</method>
<method name="visibility_notifier_create">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="RID" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<description>
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="visibility_notifier_set_aabb">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="notifier" type="RID" />
<argument index="1" name="aabb" type="AABB" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="visibility_notifier_set_callbacks">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<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" />
doc: Sync classref with current source
2021-01-04 14:33:44 +01:00
<description>
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="voxel_gi_allocate_data">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<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" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="voxel_gi_create">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="RID" />
Implement occlusion culling Added an occlusion culling system with support for static occluder meshes. It can be enabled via `Project Settings > Rendering > Occlusion Culling > Use Occlusion Culling`. Occluders are defined via the new `Occluder3D` resource and instanced using the new `OccluderInstance3D` node. The occluders can also be automatically baked from a scene using the built-in editor plugin.
2021-04-20 18:40:24 +02:00
<description>
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="voxel_gi_get_data_cells" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="PackedByteArray" />
<argument index="0" name="voxel_gi" type="RID" />
Implement occlusion culling Added an occlusion culling system with support for static occluder meshes. It can be enabled via `Project Settings > Rendering > Occlusion Culling > Use Occlusion Culling`. Occluders are defined via the new `Occluder3D` resource and instanced using the new `OccluderInstance3D` node. The occluders can also be automatically baked from a scene using the built-in editor plugin.
2021-04-20 18:40:24 +02:00
<description>
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="voxel_gi_get_distance_field" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="PackedByteArray" />
<argument index="0" name="voxel_gi" type="RID" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="voxel_gi_get_level_counts" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="PackedInt32Array" />
<argument index="0" name="voxel_gi" type="RID" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<description>
</description>
</method>
<method name="voxel_gi_get_octree_cells" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="PackedByteArray" />
<argument index="0" name="voxel_gi" type="RID" />
Implement ability to render viewports directly to screen
2019-05-08 20:25:34 +02:00
<description>
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="voxel_gi_get_octree_size" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="Vector3i" />
<argument index="0" name="voxel_gi" type="RID" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<description>
</description>
</method>
<method name="voxel_gi_get_to_cell_xform" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="Transform3D" />
<argument index="0" name="voxel_gi" type="RID" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="voxel_gi_set_bias">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="voxel_gi" type="RID" />
<argument index="1" name="bias" type="float" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="voxel_gi_set_dynamic_range">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="voxel_gi" type="RID" />
<argument index="1" name="range" type="float" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="voxel_gi_set_energy">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="voxel_gi" type="RID" />
<argument index="1" name="energy" type="float" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="voxel_gi_set_interior">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="voxel_gi" type="RID" />
<argument index="1" name="enable" type="bool" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="voxel_gi_set_normal_bias">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="voxel_gi" type="RID" />
<argument index="1" name="bias" type="float" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="voxel_gi_set_propagation">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="voxel_gi" type="RID" />
<argument index="1" name="amount" type="float" />
doc: Sync classref with current source + fixup some bindings Includes various changes triggered by the refactoring of method bindings.
2020-11-04 15:38:26 +01:00
<description>
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="voxel_gi_set_quality">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="quality" type="int" enum="RenderingServer.VoxelGIQuality" />
Implement occlusion culling Added an occlusion culling system with support for static occluder meshes. It can be enabled via `Project Settings > Rendering > Occlusion Culling > Use Occlusion Culling`. Occluders are defined via the new `Occluder3D` resource and instanced using the new `OccluderInstance3D` node. The occluders can also be automatically baked from a scene using the built-in editor plugin.
2021-04-20 18:40:24 +02:00
<description>
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<method name="voxel_gi_set_use_two_bounces">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="voxel_gi" type="RID" />
<argument index="1" name="enable" type="bool" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
</description>
</method>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</methods>
DocData: Skip language-specific ClassDoc without methods/constants Removes the useless `@C#`, `@NativeScript` and `@VisualScript` entries.
2020-06-17 15:06:13 +02:00
<members>
<member name="render_loop_enabled" type="bool" setter="set_render_loop_enabled" getter="is_render_loop_enabled">
If [code]false[/code], disables rendering completely, but the engine logic is still being processed. You can call [method force_draw] to draw a frame even with rendering disabled.
</member>
</members>
doc: Sync classref with current source
2017-11-15 20:35:18 +01:00
<signals>
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
<signal name="frame_post_draw">
<description>
doc: Update classref with node renames A few extra renames for classes which were missed in last week's PRs.
2020-03-30 18:22:57 +02:00
Emitted at the end of the frame, after the RenderingServer has finished updating all the Viewports.
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
</description>
</signal>
<signal name="frame_pre_draw">
doc: Sync classref with current source
2017-11-15 20:35:18 +01:00
<description>
doc: Update classref with node renames A few extra renames for classes which were missed in last week's PRs.
2020-03-30 18:22:57 +02:00
Emitted at the beginning of the frame, before the RenderingServer updates all the Viewports.
doc: Sync classref with current source
2017-11-15 20:35:18 +01:00
</description>
</signal>
</signals>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<constants>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="NO_INDEX_ARRAY" value="-1">
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Marks an error that shows that the index array is empty.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="ARRAY_WEIGHTS_SIZE" value="4">
Finish documenting VisualServer
2020-01-06 00:36:50 +01:00
Number of weights/bones per vertex.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="CANVAS_ITEM_Z_MIN" value="-4096">
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
The minimum Z-layer for canvas items.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="CANVAS_ITEM_Z_MAX" value="4096">
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
The maximum Z-layer for canvas items.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="MAX_GLOW_LEVELS" value="7">
Finish documenting VisualServer
2020-01-06 00:36:50 +01:00
Max number of glow levels that can be used with glow post-process effect.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="MAX_CURSORS" value="8">
Finish documenting VisualServer
2020-01-06 00:36:50 +01:00
Unused enum in Godot 3.x.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<constant name="MAX_2D_DIRECTIONAL_LIGHTS" value="8">
</constant>
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 09:59:06 +01:00
<constant name="TEXTURE_LAYERED_2D_ARRAY" value="0" enum="TextureLayeredType">
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 09:59:06 +01:00
<constant name="TEXTURE_LAYERED_CUBEMAP" value="1" enum="TextureLayeredType">
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 09:59:06 +01:00
<constant name="TEXTURE_LAYERED_CUBEMAP_ARRAY" value="2" enum="TextureLayeredType">
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 09:59:06 +01:00
<constant name="CUBEMAP_LAYER_LEFT" value="0" enum="CubeMapLayer">
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 09:59:06 +01:00
<constant name="CUBEMAP_LAYER_RIGHT" value="1" enum="CubeMapLayer">
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 09:59:06 +01:00
<constant name="CUBEMAP_LAYER_BOTTOM" value="2" enum="CubeMapLayer">
doc: Sync classref with current source
2018-08-21 00:35:30 +02:00
</constant>
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 09:59:06 +01:00
<constant name="CUBEMAP_LAYER_TOP" value="3" enum="CubeMapLayer">
doc: Sync classref with current source
2018-08-21 00:35:30 +02:00
</constant>
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 09:59:06 +01:00
<constant name="CUBEMAP_LAYER_FRONT" value="4" enum="CubeMapLayer">
doc: Sync classref with current source
2018-08-21 00:35:30 +02:00
</constant>
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 09:59:06 +01:00
<constant name="CUBEMAP_LAYER_BACK" value="5" enum="CubeMapLayer">
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="SHADER_SPATIAL" value="0" enum="ShaderMode">
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Shader is a 3D shader.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="SHADER_CANVAS_ITEM" value="1" enum="ShaderMode">
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Shader is a 2D shader.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="SHADER_PARTICLES" value="2" enum="ShaderMode">
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Shader is a particle shader.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
Working sky shader implementation
2020-03-20 01:32:19 +01:00
<constant name="SHADER_SKY" value="3" enum="ShaderMode">
Shader is a sky shader.
</constant>
Addition of FogVolumes, FogShaders, FogMaterial, and overhaul of VolumetricFog Co-authored-by: Brian Semrau <brian.semrau@gmail.com>
2021-10-03 13:28:55 +02:00
<constant name="SHADER_FOG" value="4" enum="ShaderMode">
Shader is a fog shader.
</constant>
<constant name="SHADER_MAX" value="5" enum="ShaderMode">
doc: Complete and harmonize all _MAX constant descriptions
2019-06-27 11:10:53 +02:00
Represents the size of the [enum ShaderMode] enum.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Sync classref with current source Add missing enum bindings.
2020-04-20 11:48:00 +02:00
<constant name="MATERIAL_RENDER_PRIORITY_MIN" value="-128">
The minimum renderpriority of all materials.
</constant>
<constant name="MATERIAL_RENDER_PRIORITY_MAX" value="127">
The maximum renderpriority of all materials.
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="ARRAY_VERTEX" value="0" enum="ArrayType">
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Array is a vertex array.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="ARRAY_NORMAL" value="1" enum="ArrayType">
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Array is a normal array.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="ARRAY_TANGENT" value="2" enum="ArrayType">
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Array is a tangent array.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="ARRAY_COLOR" value="3" enum="ArrayType">
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Array is a color array.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="ARRAY_TEX_UV" value="4" enum="ArrayType">
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-22 01:04:47 +02:00
Array is an UV coordinates array.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="ARRAY_TEX_UV2" value="5" enum="ArrayType">
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-22 01:04:47 +02:00
Array is an UV coordinates array for the second UV coordinates.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Sync classref with current source And fixups: - Add missing bindings in RenderingServer - Remove duplicate ArrayMesh enum bindings (they're in Mesh already) - Remove redundant _unhandled_key_input binding in Control (it's in Node already)
2020-12-04 15:54:48 +01:00
<constant name="ARRAY_CUSTOM0" value="6" enum="ArrayType">
</constant>
<constant name="ARRAY_CUSTOM1" value="7" enum="ArrayType">
</constant>
<constant name="ARRAY_CUSTOM2" value="8" enum="ArrayType">
</constant>
<constant name="ARRAY_CUSTOM3" value="9" enum="ArrayType">
</constant>
<constant name="ARRAY_BONES" value="10" enum="ArrayType">
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Array contains bone information.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Sync classref with current source And fixups: - Add missing bindings in RenderingServer - Remove duplicate ArrayMesh enum bindings (they're in Mesh already) - Remove redundant _unhandled_key_input binding in Control (it's in Node already)
2020-12-04 15:54:48 +01:00
<constant name="ARRAY_WEIGHTS" value="11" enum="ArrayType">
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Array is weight information.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Sync classref with current source And fixups: - Add missing bindings in RenderingServer - Remove duplicate ArrayMesh enum bindings (they're in Mesh already) - Remove redundant _unhandled_key_input binding in Control (it's in Node already)
2020-12-04 15:54:48 +01:00
<constant name="ARRAY_INDEX" value="12" enum="ArrayType">
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Array is index array.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Sync classref with current source And fixups: - Add missing bindings in RenderingServer - Remove duplicate ArrayMesh enum bindings (they're in Mesh already) - Remove redundant _unhandled_key_input binding in Control (it's in Node already)
2020-12-04 15:54:48 +01:00
<constant name="ARRAY_MAX" value="13" enum="ArrayType">
doc: Complete and harmonize all _MAX constant descriptions
2019-06-27 11:10:53 +02:00
Represents the size of the [enum ArrayType] enum.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<constant name="ARRAY_CUSTOM_COUNT" value="4">
</constant>
<constant name="ARRAY_CUSTOM_RGBA8_UNORM" value="0" enum="ArrayCustomFormat">
</constant>
<constant name="ARRAY_CUSTOM_RGBA8_SNORM" value="1" enum="ArrayCustomFormat">
</constant>
<constant name="ARRAY_CUSTOM_RG_HALF" value="2" enum="ArrayCustomFormat">
</constant>
<constant name="ARRAY_CUSTOM_RGBA_HALF" value="3" enum="ArrayCustomFormat">
</constant>
<constant name="ARRAY_CUSTOM_R_FLOAT" value="4" enum="ArrayCustomFormat">
</constant>
<constant name="ARRAY_CUSTOM_RG_FLOAT" value="5" enum="ArrayCustomFormat">
</constant>
<constant name="ARRAY_CUSTOM_RGB_FLOAT" value="6" enum="ArrayCustomFormat">
</constant>
<constant name="ARRAY_CUSTOM_RGBA_FLOAT" value="7" enum="ArrayCustomFormat">
</constant>
<constant name="ARRAY_CUSTOM_MAX" value="8" enum="ArrayCustomFormat">
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="ARRAY_FORMAT_VERTEX" value="1" enum="ArrayFormat">
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Flag used to mark a vertex array.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="ARRAY_FORMAT_NORMAL" value="2" enum="ArrayFormat">
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Flag used to mark a normal array.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="ARRAY_FORMAT_TANGENT" value="4" enum="ArrayFormat">
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Flag used to mark a tangent array.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="ARRAY_FORMAT_COLOR" value="8" enum="ArrayFormat">
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Flag used to mark a color array.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="ARRAY_FORMAT_TEX_UV" value="16" enum="ArrayFormat">
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-22 01:04:47 +02:00
Flag used to mark an UV coordinates array.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="ARRAY_FORMAT_TEX_UV2" value="32" enum="ArrayFormat">
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-22 01:04:47 +02:00
Flag used to mark an UV coordinates array for the second UV coordinates.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Sync classref with current source And fixups: - Add missing bindings in RenderingServer - Remove duplicate ArrayMesh enum bindings (they're in Mesh already) - Remove redundant _unhandled_key_input binding in Control (it's in Node already)
2020-12-04 15:54:48 +01:00
<constant name="ARRAY_FORMAT_CUSTOM0" value="64" enum="ArrayFormat">
</constant>
<constant name="ARRAY_FORMAT_CUSTOM1" value="128" enum="ArrayFormat">
</constant>
<constant name="ARRAY_FORMAT_CUSTOM2" value="256" enum="ArrayFormat">
</constant>
<constant name="ARRAY_FORMAT_CUSTOM3" value="512" enum="ArrayFormat">
</constant>
<constant name="ARRAY_FORMAT_BONES" value="1024" enum="ArrayFormat">
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Flag used to mark a bone information array.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Sync classref with current source And fixups: - Add missing bindings in RenderingServer - Remove duplicate ArrayMesh enum bindings (they're in Mesh already) - Remove redundant _unhandled_key_input binding in Control (it's in Node already)
2020-12-04 15:54:48 +01:00
<constant name="ARRAY_FORMAT_WEIGHTS" value="2048" enum="ArrayFormat">
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Flag used to mark a weights array.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Sync classref with current source And fixups: - Add missing bindings in RenderingServer - Remove duplicate ArrayMesh enum bindings (they're in Mesh already) - Remove redundant _unhandled_key_input binding in Control (it's in Node already)
2020-12-04 15:54:48 +01:00
<constant name="ARRAY_FORMAT_INDEX" value="4096" enum="ArrayFormat">
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-22 01:04:47 +02:00
Flag used to mark an index array.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
Rebind Mesh/ArrayMesh enums
2020-12-05 01:26:29 +01:00
<constant name="ARRAY_FORMAT_BLEND_SHAPE_MASK" value="2147475463" enum="ArrayFormat">
doc: Sync classref with current source And fixups: - Add missing bindings in RenderingServer - Remove duplicate ArrayMesh enum bindings (they're in Mesh already) - Remove redundant _unhandled_key_input binding in Control (it's in Node already)
2020-12-04 15:54:48 +01:00
</constant>
<constant name="ARRAY_FORMAT_CUSTOM_BASE" value="13" enum="ArrayFormat">
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<constant name="ARRAY_FORMAT_CUSTOM_BITS" value="3" enum="ArrayFormat">
</constant>
doc: Sync classref with current source And fixups: - Add missing bindings in RenderingServer - Remove duplicate ArrayMesh enum bindings (they're in Mesh already) - Remove redundant _unhandled_key_input binding in Control (it's in Node already)
2020-12-04 15:54:48 +01:00
<constant name="ARRAY_FORMAT_CUSTOM0_SHIFT" value="13" enum="ArrayFormat">
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Sync classref with current source And fixups: - Add missing bindings in RenderingServer - Remove duplicate ArrayMesh enum bindings (they're in Mesh already) - Remove redundant _unhandled_key_input binding in Control (it's in Node already)
2020-12-04 15:54:48 +01:00
<constant name="ARRAY_FORMAT_CUSTOM1_SHIFT" value="16" enum="ArrayFormat">
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Sync classref with current source And fixups: - Add missing bindings in RenderingServer - Remove duplicate ArrayMesh enum bindings (they're in Mesh already) - Remove redundant _unhandled_key_input binding in Control (it's in Node already)
2020-12-04 15:54:48 +01:00
<constant name="ARRAY_FORMAT_CUSTOM2_SHIFT" value="19" enum="ArrayFormat">
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Sync classref with current source And fixups: - Add missing bindings in RenderingServer - Remove duplicate ArrayMesh enum bindings (they're in Mesh already) - Remove redundant _unhandled_key_input binding in Control (it's in Node already)
2020-12-04 15:54:48 +01:00
<constant name="ARRAY_FORMAT_CUSTOM3_SHIFT" value="22" enum="ArrayFormat">
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Sync classref with current source And fixups: - Add missing bindings in RenderingServer - Remove duplicate ArrayMesh enum bindings (they're in Mesh already) - Remove redundant _unhandled_key_input binding in Control (it's in Node already)
2020-12-04 15:54:48 +01:00
<constant name="ARRAY_FORMAT_CUSTOM_MASK" value="7" enum="ArrayFormat">
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Sync classref with current source And fixups: - Add missing bindings in RenderingServer - Remove duplicate ArrayMesh enum bindings (they're in Mesh already) - Remove redundant _unhandled_key_input binding in Control (it's in Node already)
2020-12-04 15:54:48 +01:00
<constant name="ARRAY_COMPRESS_FLAGS_BASE" value="25" enum="ArrayFormat">
doc: Sync classref with current source Add missing enum bindings.
2020-04-20 11:48:00 +02:00
</constant>
doc: Sync classref with current source And fixups: - Add missing bindings in RenderingServer - Remove duplicate ArrayMesh enum bindings (they're in Mesh already) - Remove redundant _unhandled_key_input binding in Control (it's in Node already)
2020-12-04 15:54:48 +01:00
<constant name="ARRAY_FLAG_USE_2D_VERTICES" value="33554432" enum="ArrayFormat">
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Flag used to mark that the array contains 2D vertices.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Sync classref with current source And fixups: - Add missing bindings in RenderingServer - Remove duplicate ArrayMesh enum bindings (they're in Mesh already) - Remove redundant _unhandled_key_input binding in Control (it's in Node already)
2020-12-04 15:54:48 +01:00
<constant name="ARRAY_FLAG_USE_DYNAMIC_UPDATE" value="67108864" enum="ArrayFormat">
</constant>
<constant name="ARRAY_FLAG_USE_8_BONE_WEIGHTS" value="134217728" enum="ArrayFormat">
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="PRIMITIVE_POINTS" value="0" enum="PrimitiveType">
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Primitive to draw consists of points.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="PRIMITIVE_LINES" value="1" enum="PrimitiveType">
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Primitive to draw consists of lines.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="PRIMITIVE_LINE_STRIP" value="2" enum="PrimitiveType">
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Primitive to draw consists of a line strip from start to end.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 09:59:06 +01:00
<constant name="PRIMITIVE_TRIANGLES" value="3" enum="PrimitiveType">
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Primitive to draw consists of triangles.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 09:59:06 +01:00
<constant name="PRIMITIVE_TRIANGLE_STRIP" value="4" enum="PrimitiveType">
Fix typos in code and docs with codespell Using v1.11.0 from https://github.com/lucasdemarchi/codespell
2018-01-18 21:37:17 +01:00
Primitive to draw consists of a triangle strip (the last 3 vertices are always combined to make a triangle).
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 09:59:06 +01:00
<constant name="PRIMITIVE_MAX" value="5" enum="PrimitiveType">
doc: Complete and harmonize all _MAX constant descriptions
2019-06-27 11:10:53 +02:00
Represents the size of the [enum PrimitiveType] enum.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="BLEND_SHAPE_MODE_NORMALIZED" value="0" enum="BlendShapeMode">
Finish documenting VisualServer
2020-01-06 00:36:50 +01:00
Blend shapes are normalized.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="BLEND_SHAPE_MODE_RELATIVE" value="1" enum="BlendShapeMode">
Finish documenting VisualServer
2020-01-06 00:36:50 +01:00
Blend shapes are relative to base weight.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 09:59:06 +01:00
<constant name="MULTIMESH_TRANSFORM_2D" value="0" enum="MultimeshTransformFormat">
Use [Transform2D] to store MultiMesh transform.
</constant>
<constant name="MULTIMESH_TRANSFORM_3D" value="1" enum="MultimeshTransformFormat">
Update documentation for Transform3D
2020-05-03 10:27:36 +02:00
Use [Transform3D] to store MultiMesh transform.
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 09:59:06 +01:00
</constant>
Implement more rendering options as specialization constants * Shadow quality settings now specialization constant. * Decal and light projector filters can be set. * Changing those settings forces re-creation of the pipelines. These changes should help improve performance related to shadow mapping, and allows improving performance by sacrificing decal and light projector quality.
2021-07-19 21:41:55 +02:00
<constant name="LIGHT_PROJECTOR_FILTER_NEAREST" value="0" enum="LightProjectorFilter">
</constant>
<constant name="LIGHT_PROJECTOR_FILTER_NEAREST_MIPMAPS" value="1" enum="LightProjectorFilter">
</constant>
<constant name="LIGHT_PROJECTOR_FILTER_LINEAR" value="2" enum="LightProjectorFilter">
</constant>
<constant name="LIGHT_PROJECTOR_FILTER_LINEAR_MIPMAPS" value="3" enum="LightProjectorFilter">
</constant>
<constant name="LIGHT_PROJECTOR_FILTER_LINEAR_MIPMAPS_ANISOTROPIC" value="4" enum="LightProjectorFilter">
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="LIGHT_DIRECTIONAL" value="0" enum="LightType">
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Is a directional (sun) light.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="LIGHT_OMNI" value="1" enum="LightType">
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-22 01:04:47 +02:00
Is an omni light.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="LIGHT_SPOT" value="2" enum="LightType">
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-22 01:04:47 +02:00
Is a spot light.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="LIGHT_PARAM_ENERGY" value="0" enum="LightParam">
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
The light's energy.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 09:59:06 +01:00
<constant name="LIGHT_PARAM_INDIRECT_ENERGY" value="1" enum="LightParam">
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="LIGHT_PARAM_SPECULAR" value="2" enum="LightParam">
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
The light's influence on specularity.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="LIGHT_PARAM_RANGE" value="3" enum="LightParam">
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
The light's range.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
Add proper quality settings to soft shadows
2020-04-10 11:30:36 +02:00
<constant name="LIGHT_PARAM_SIZE" value="4" 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">
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
The light's attenuation.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
Add proper quality settings to soft shadows
2020-04-10 11:30:36 +02:00
<constant name="LIGHT_PARAM_SPOT_ANGLE" value="6" enum="LightParam">
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
The spotlight's angle.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
Add proper quality settings to soft shadows
2020-04-10 11:30:36 +02:00
<constant name="LIGHT_PARAM_SPOT_ATTENUATION" value="7" enum="LightParam">
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
The spotlight's attenuation.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="LIGHT_PARAM_SHADOW_MAX_DISTANCE" value="8" enum="LightParam">
Finish documenting VisualServer
2020-01-06 00:36:50 +01:00
Max distance that shadows will be rendered.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="LIGHT_PARAM_SHADOW_SPLIT_1_OFFSET" value="9" enum="LightParam">
Finish documenting VisualServer
2020-01-06 00:36:50 +01:00
Proportion of shadow atlas occupied by the first split.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="LIGHT_PARAM_SHADOW_SPLIT_2_OFFSET" value="10" enum="LightParam">
Finish documenting VisualServer
2020-01-06 00:36:50 +01:00
Proportion of shadow atlas occupied by the second split.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="LIGHT_PARAM_SHADOW_SPLIT_3_OFFSET" value="11" enum="LightParam">
Finish documenting VisualServer
2020-01-06 00:36:50 +01:00
Proportion of shadow atlas occupied by the third split. The fourth split occupies the rest.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 09:59:06 +01:00
<constant name="LIGHT_PARAM_SHADOW_FADE_START" value="12" enum="LightParam">
Update many docs with recent rendering changes
2020-04-17 01:05:25 +02:00
Proportion of shadow max distance where the shadow will start to fade out.
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 09:59:06 +01:00
</constant>
<constant name="LIGHT_PARAM_SHADOW_NORMAL_BIAS" value="13" enum="LightParam">
Finish documenting VisualServer
2020-01-06 00:36:50 +01:00
Normal bias used to offset shadow lookup by object normal. Can be used to fix self-shadowing artifacts.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 09:59:06 +01:00
<constant name="LIGHT_PARAM_SHADOW_BIAS" value="14" enum="LightParam">
Finish documenting VisualServer
2020-01-06 00:36:50 +01:00
Bias the shadow lookup to fix self-shadowing artifacts.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
Update many docs with recent rendering changes
2020-04-17 01:05:25 +02:00
<constant name="LIGHT_PARAM_SHADOW_PANCAKE_SIZE" value="15" 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.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
Update many docs with recent rendering changes
2020-04-17 01:05:25 +02:00
<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>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<constant name="LIGHT_PARAM_SHADOW_VOLUMETRIC_FOG_FADE" value="17" enum="LightParam">
</constant>
doc: Sync classref with current source
2020-08-31 11:25:11 +02:00
<constant name="LIGHT_PARAM_TRANSMITTANCE_BIAS" value="18" enum="LightParam">
Update many docs with recent rendering changes
2020-04-17 01:05:25 +02:00
</constant>
doc: Sync classref with current source
2020-08-31 11:25:11 +02:00
<constant name="LIGHT_PARAM_MAX" value="19" enum="LightParam">
doc: Complete and harmonize all _MAX constant descriptions
2019-06-27 11:10:53 +02:00
Represents the size of the [enum LightParam] enum.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
Environment: Refactor code for readability + more - Makes all boolean setters/getters consistent. - Fixes bug where `glow_hdr_bleed_scale` was not used. - Split CameraEffects to their own source file. - Reorder all Environment method and properties declarations, definitions and bindings to be consistent with each other and with the order of property bindings. - Bind missing enum values added with SDFGI. - Remove unused SDFGI enhance_ssr boolean. - Sync doc changes after SDFGI merge and other misc changes.
2020-07-01 14:18:13 +02:00
<constant name="LIGHT_BAKE_DISABLED" value="0" enum="LightBakeMode">
</constant>
<constant name="LIGHT_BAKE_DYNAMIC" value="1" enum="LightBakeMode">
</constant>
<constant name="LIGHT_BAKE_STATIC" value="2" enum="LightBakeMode">
</constant>
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<constant name="LIGHT_OMNI_SHADOW_DUAL_PARABOLOID" value="0" enum="LightOmniShadowMode">
Finish documenting VisualServer
2020-01-06 00:36:50 +01:00
Use a dual paraboloid shadow map for omni lights.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</constant>
<constant name="LIGHT_OMNI_SHADOW_CUBE" value="1" enum="LightOmniShadowMode">
Finish documenting VisualServer
2020-01-06 00:36:50 +01:00
Use a cubemap shadow map for omni lights. Slower but better quality than dual paraboloid.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</constant>
<constant name="LIGHT_DIRECTIONAL_SHADOW_ORTHOGONAL" value="0" enum="LightDirectionalShadowMode">
Finish documenting VisualServer
2020-01-06 00:36:50 +01:00
Use orthogonal shadow projection for directional light.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</constant>
<constant name="LIGHT_DIRECTIONAL_SHADOW_PARALLEL_2_SPLITS" value="1" enum="LightDirectionalShadowMode">
Finish documenting VisualServer
2020-01-06 00:36:50 +01:00
Use 2 splits for shadow projection when using directional light.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</constant>
<constant name="LIGHT_DIRECTIONAL_SHADOW_PARALLEL_4_SPLITS" value="2" enum="LightDirectionalShadowMode">
Finish documenting VisualServer
2020-01-06 00:36:50 +01:00
Use 4 splits for shadow projection when using directional light.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</constant>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<constant name="SHADOW_QUALITY_HARD" value="0" enum="ShadowQuality">
Add Soft Very Low shadow quality mode for 3D This can be used to improve 3D shadow rendering quality at little performance cost. Unlike the existing Hard setting which is limited to variable shadow blur only, it works with both fixed blur and variable blur.
2021-10-19 16:52:57 +02:00
Lowest shadow filtering quality (fastest). Soft shadows are not available with this quality setting, which means the [member Light3D.shadow_blur] property is ignored if [member Light3D.light_size] and [member Light3D.light_angular_distance] is [code]0.0[/code].
[b]Note:[/b] The variable shadow blur performed by [member Light3D.light_size] and [member Light3D.light_angular_distance] is still effective when using hard shadow filtering. In this case, [member Light3D.shadow_blur] [i]is[/i] taken into account. However, the results will not be blurred, instead the blur amount is treated as a maximum radius for the penumbra.
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
</constant>
Add Soft Very Low shadow quality mode for 3D This can be used to improve 3D shadow rendering quality at little performance cost. Unlike the existing Hard setting which is limited to variable shadow blur only, it works with both fixed blur and variable blur.
2021-10-19 16:52:57 +02:00
<constant name="SHADOW_QUALITY_SOFT_VERY_LOW" value="1" enum="ShadowQuality">
Very low shadow filtering quality (faster). When using this quality setting, [member Light3D.shadow_blur] is automatically multiplied by 0.75× to avoid introducing too much noise. This division only applies to lights whose [member Light3D.light_size] or [member Light3D.light_angular_distance] is [code]0.0[/code]).
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
</constant>
Add Soft Very Low shadow quality mode for 3D This can be used to improve 3D shadow rendering quality at little performance cost. Unlike the existing Hard setting which is limited to variable shadow blur only, it works with both fixed blur and variable blur.
2021-10-19 16:52:57 +02:00
<constant name="SHADOW_QUALITY_SOFT_LOW" value="2" enum="ShadowQuality">
Low shadow filtering quality (fast).
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
</constant>
Add Soft Very Low shadow quality mode for 3D This can be used to improve 3D shadow rendering quality at little performance cost. Unlike the existing Hard setting which is limited to variable shadow blur only, it works with both fixed blur and variable blur.
2021-10-19 16:52:57 +02:00
<constant name="SHADOW_QUALITY_SOFT_MEDIUM" value="3" enum="ShadowQuality">
Medium low shadow filtering quality (average).
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
</constant>
Add Soft Very Low shadow quality mode for 3D This can be used to improve 3D shadow rendering quality at little performance cost. Unlike the existing Hard setting which is limited to variable shadow blur only, it works with both fixed blur and variable blur.
2021-10-19 16:52:57 +02:00
<constant name="SHADOW_QUALITY_SOFT_HIGH" value="4" enum="ShadowQuality">
High low shadow filtering quality (slow). When using this quality setting, [member Light3D.shadow_blur] is automatically multiplied by 1.5× to better make use of the high sample count. This increased blur also improves the stability of dynamic object shadows. This multiplier only applies to lights whose [member Light3D.light_size] or [member Light3D.light_angular_distance] is [code]0.0[/code]).
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
</constant>
Add Soft Very Low shadow quality mode for 3D This can be used to improve 3D shadow rendering quality at little performance cost. Unlike the existing Hard setting which is limited to variable shadow blur only, it works with both fixed blur and variable blur.
2021-10-19 16:52:57 +02:00
<constant name="SHADOW_QUALITY_SOFT_ULTRA" value="5" enum="ShadowQuality">
Highest low shadow filtering quality (slowest). When using this quality setting, [member Light3D.shadow_blur] is automatically multiplied by 2× to better make use of the high sample count. This increased blur also improves the stability of dynamic object shadows. This multiplier only applies to lights whose [member Light3D.light_size] or [member Light3D.light_angular_distance] is [code]0.0[/code]).
</constant>
<constant name="SHADOW_QUALITY_MAX" value="6" enum="ShadowQuality">
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
</constant>
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 09:59:06 +01:00
<constant name="REFLECTION_PROBE_UPDATE_ONCE" value="0" enum="ReflectionProbeUpdateMode">
Reflection probe will update reflections once and then stop.
</constant>
<constant name="REFLECTION_PROBE_UPDATE_ALWAYS" value="1" enum="ReflectionProbeUpdateMode">
Reflection probe will update each frame. This mode is necessary to capture moving objects.
</constant>
Environment: Refactor code for readability + more - Makes all boolean setters/getters consistent. - Fixes bug where `glow_hdr_bleed_scale` was not used. - Split CameraEffects to their own source file. - Reorder all Environment method and properties declarations, definitions and bindings to be consistent with each other and with the order of property bindings. - Bind missing enum values added with SDFGI. - Remove unused SDFGI enhance_ssr boolean. - Sync doc changes after SDFGI merge and other misc changes.
2020-07-01 14:18:13 +02:00
<constant name="REFLECTION_PROBE_AMBIENT_DISABLED" value="0" enum="ReflectionProbeAmbientMode">
</constant>
<constant name="REFLECTION_PROBE_AMBIENT_ENVIRONMENT" value="1" enum="ReflectionProbeAmbientMode">
</constant>
<constant name="REFLECTION_PROBE_AMBIENT_COLOR" value="2" enum="ReflectionProbeAmbientMode">
</constant>
doc: Sync classref with current source Add missing enum bindings.
2020-04-20 11:48:00 +02:00
<constant name="DECAL_TEXTURE_ALBEDO" value="0" enum="DecalTexture">
</constant>
<constant name="DECAL_TEXTURE_NORMAL" value="1" enum="DecalTexture">
</constant>
<constant name="DECAL_TEXTURE_ORM" value="2" enum="DecalTexture">
</constant>
<constant name="DECAL_TEXTURE_EMISSION" value="3" enum="DecalTexture">
</constant>
<constant name="DECAL_TEXTURE_MAX" value="4" enum="DecalTexture">
</constant>
Implement more rendering options as specialization constants * Shadow quality settings now specialization constant. * Decal and light projector filters can be set. * Changing those settings forces re-creation of the pipelines. These changes should help improve performance related to shadow mapping, and allows improving performance by sacrificing decal and light projector quality.
2021-07-19 21:41:55 +02:00
<constant name="DECAL_FILTER_NEAREST" value="0" enum="DecalFilter">
</constant>
<constant name="DECAL_FILTER_NEAREST_MIPMAPS" value="1" enum="DecalFilter">
</constant>
<constant name="DECAL_FILTER_LINEAR" value="2" enum="DecalFilter">
</constant>
<constant name="DECAL_FILTER_LINEAR_MIPMAPS" value="3" enum="DecalFilter">
</constant>
<constant name="DECAL_FILTER_LINEAR_MIPMAPS_ANISOTROPIC" value="4" enum="DecalFilter">
</constant>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<constant name="VOXEL_GI_QUALITY_LOW" value="0" enum="VoxelGIQuality">
</constant>
<constant name="VOXEL_GI_QUALITY_HIGH" value="1" enum="VoxelGIQuality">
</constant>
<constant name="PARTICLES_MODE_2D" value="0" enum="ParticlesMode">
</constant>
<constant name="PARTICLES_MODE_3D" value="1" enum="ParticlesMode">
</constant>
<constant name="PARTICLES_TRANSFORM_ALIGN_DISABLED" value="0" enum="ParticlesTransformAlign">
</constant>
<constant name="PARTICLES_TRANSFORM_ALIGN_Z_BILLBOARD" value="1" enum="ParticlesTransformAlign">
</constant>
<constant name="PARTICLES_TRANSFORM_ALIGN_Y_TO_VELOCITY" value="2" enum="ParticlesTransformAlign">
</constant>
<constant name="PARTICLES_TRANSFORM_ALIGN_Z_BILLBOARD_Y_TO_VELOCITY" value="3" enum="ParticlesTransformAlign">
</constant>
<constant name="PARTICLES_EMIT_FLAG_POSITION" value="1">
</constant>
<constant name="PARTICLES_EMIT_FLAG_ROTATION_SCALE" value="2">
</constant>
<constant name="PARTICLES_EMIT_FLAG_VELOCITY" value="4">
</constant>
<constant name="PARTICLES_EMIT_FLAG_COLOR" value="8">
</constant>
<constant name="PARTICLES_EMIT_FLAG_CUSTOM" value="16">
</constant>
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 09:59:06 +01:00
<constant name="PARTICLES_DRAW_ORDER_INDEX" value="0" enum="ParticlesDrawOrder">
Draw particles in the order that they appear in the particles array.
</constant>
<constant name="PARTICLES_DRAW_ORDER_LIFETIME" value="1" enum="ParticlesDrawOrder">
Sort particles based on their lifetime.
</constant>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<constant name="PARTICLES_DRAW_ORDER_REVERSE_LIFETIME" value="2" enum="ParticlesDrawOrder">
</constant>
Support for 2D particles to collide against SDF -Added SDF collision support for 2D particles -Changed the SDF generation to be fully signed
2021-05-20 16:25:06 +02:00
<constant name="PARTICLES_DRAW_ORDER_VIEW_DEPTH" value="3" enum="ParticlesDrawOrder">
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 09:59:06 +01:00
Sort particles based on their distance to the camera.
</constant>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<constant name="PARTICLES_COLLISION_TYPE_SPHERE_ATTRACT" value="0" enum="ParticlesCollisionType">
</constant>
<constant name="PARTICLES_COLLISION_TYPE_BOX_ATTRACT" value="1" enum="ParticlesCollisionType">
</constant>
<constant name="PARTICLES_COLLISION_TYPE_VECTOR_FIELD_ATTRACT" value="2" enum="ParticlesCollisionType">
</constant>
<constant name="PARTICLES_COLLISION_TYPE_SPHERE_COLLIDE" value="3" enum="ParticlesCollisionType">
</constant>
<constant name="PARTICLES_COLLISION_TYPE_BOX_COLLIDE" value="4" enum="ParticlesCollisionType">
</constant>
<constant name="PARTICLES_COLLISION_TYPE_SDF_COLLIDE" value="5" enum="ParticlesCollisionType">
</constant>
<constant name="PARTICLES_COLLISION_TYPE_HEIGHTFIELD_COLLIDE" value="6" enum="ParticlesCollisionType">
</constant>
<constant name="PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_256" value="0" enum="ParticlesCollisionHeightfieldResolution">
</constant>
<constant name="PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_512" value="1" enum="ParticlesCollisionHeightfieldResolution">
</constant>
<constant name="PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_1024" value="2" enum="ParticlesCollisionHeightfieldResolution">
</constant>
<constant name="PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_2048" value="3" enum="ParticlesCollisionHeightfieldResolution">
</constant>
<constant name="PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_4096" value="4" enum="ParticlesCollisionHeightfieldResolution">
</constant>
<constant name="PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_8192" value="5" enum="ParticlesCollisionHeightfieldResolution">
</constant>
<constant name="PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_MAX" value="6" enum="ParticlesCollisionHeightfieldResolution">
</constant>
Addition of FogVolumes, FogShaders, FogMaterial, and overhaul of VolumetricFog Co-authored-by: Brian Semrau <brian.semrau@gmail.com>
2021-10-03 13:28:55 +02:00
<constant name="FOG_VOLUME_SHAPE_ELLIPSOID" value="0" enum="FogVolumeShape">
[FogVolume] will be shaped like an ellipsoid.
</constant>
<constant name="FOG_VOLUME_SHAPE_BOX" value="1" enum="FogVolumeShape">
[FogVolume] will be shaped like a box.
</constant>
<constant name="FOG_VOLUME_SHAPE_WORLD" value="2" enum="FogVolumeShape">
[FogVolume] will have no shape, will cover the whole world and will not be culled.
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="VIEWPORT_UPDATE_DISABLED" value="0" enum="ViewportUpdateMode">
Finish documenting VisualServer
2020-01-06 00:36:50 +01:00
Do not update the viewport.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="VIEWPORT_UPDATE_ONCE" value="1" enum="ViewportUpdateMode">
Finish documenting VisualServer
2020-01-06 00:36:50 +01:00
Update the viewport once then set to disabled.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="VIEWPORT_UPDATE_WHEN_VISIBLE" value="2" enum="ViewportUpdateMode">
Finish documenting VisualServer
2020-01-06 00:36:50 +01:00
Update the viewport whenever it is visible.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Sync classref with DisplayServer/Window changes
2020-03-31 11:56:58 +02:00
<constant name="VIEWPORT_UPDATE_WHEN_PARENT_VISIBLE" value="3" enum="ViewportUpdateMode">
</constant>
<constant name="VIEWPORT_UPDATE_ALWAYS" value="4" enum="ViewportUpdateMode">
Finish documenting VisualServer
2020-01-06 00:36:50 +01:00
Always update the viewport.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="VIEWPORT_CLEAR_ALWAYS" value="0" enum="ViewportClearMode">
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
The viewport is always cleared before drawing.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="VIEWPORT_CLEAR_NEVER" value="1" enum="ViewportClearMode">
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
The viewport is never cleared before drawing.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="VIEWPORT_CLEAR_ONLY_NEXT_FRAME" value="2" enum="ViewportClearMode">
doc: Replace all [code]CONSTANT[/code] by new [constant CONSTANT] hyperlinks
2019-06-27 12:34:26 +02:00
The viewport is cleared once, then the clear mode is set to [constant VIEWPORT_CLEAR_NEVER].
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<constant name="VIEWPORT_SDF_OVERSIZE_100_PERCENT" value="0" enum="ViewportSDFOversize">
</constant>
<constant name="VIEWPORT_SDF_OVERSIZE_120_PERCENT" value="1" enum="ViewportSDFOversize">
</constant>
<constant name="VIEWPORT_SDF_OVERSIZE_150_PERCENT" value="2" enum="ViewportSDFOversize">
</constant>
<constant name="VIEWPORT_SDF_OVERSIZE_200_PERCENT" value="3" enum="ViewportSDFOversize">
</constant>
<constant name="VIEWPORT_SDF_OVERSIZE_MAX" value="4" enum="ViewportSDFOversize">
</constant>
<constant name="VIEWPORT_SDF_SCALE_100_PERCENT" value="0" enum="ViewportSDFScale">
</constant>
<constant name="VIEWPORT_SDF_SCALE_50_PERCENT" value="1" enum="ViewportSDFScale">
</constant>
<constant name="VIEWPORT_SDF_SCALE_25_PERCENT" value="2" enum="ViewportSDFScale">
</constant>
<constant name="VIEWPORT_SDF_SCALE_MAX" value="3" enum="ViewportSDFScale">
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="VIEWPORT_MSAA_DISABLED" value="0" enum="ViewportMSAA">
Remove 16× MSAA support due to driver bugs and low performance In the `master` branch, 16× MSAA caused the entire system to freeze on NVIDIA GPUs. This is likely caused by graphics drivers not actually implementing 16× MSAA, but combining 8× MSAA with 2× SSAA instead. On top of that, modern shader complexity makes 16× MSAA very difficult to use while keeping a good framerate. 8× MSAA is hard enough to use as it is.
2021-05-25 16:25:10 +02:00
Multisample antialiasing for 3D is disabled. This is the default value, and also the fastest setting.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="VIEWPORT_MSAA_2X" value="1" enum="ViewportMSAA">
Remove 16× MSAA support due to driver bugs and low performance In the `master` branch, 16× MSAA caused the entire system to freeze on NVIDIA GPUs. This is likely caused by graphics drivers not actually implementing 16× MSAA, but combining 8× MSAA with 2× SSAA instead. On top of that, modern shader complexity makes 16× MSAA very difficult to use while keeping a good framerate. 8× MSAA is hard enough to use as it is.
2021-05-25 16:25:10 +02:00
Multisample antialiasing uses 2 samples per pixel for 3D. This has a moderate impact on performance.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="VIEWPORT_MSAA_4X" value="2" enum="ViewportMSAA">
Remove 16× MSAA support due to driver bugs and low performance In the `master` branch, 16× MSAA caused the entire system to freeze on NVIDIA GPUs. This is likely caused by graphics drivers not actually implementing 16× MSAA, but combining 8× MSAA with 2× SSAA instead. On top of that, modern shader complexity makes 16× MSAA very difficult to use while keeping a good framerate. 8× MSAA is hard enough to use as it is.
2021-05-25 16:25:10 +02:00
Multisample antialiasing uses 4 samples per pixel for 3D. This has a high impact on performance.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="VIEWPORT_MSAA_8X" value="3" enum="ViewportMSAA">
Remove 16× MSAA support due to driver bugs and low performance In the `master` branch, 16× MSAA caused the entire system to freeze on NVIDIA GPUs. This is likely caused by graphics drivers not actually implementing 16× MSAA, but combining 8× MSAA with 2× SSAA instead. On top of that, modern shader complexity makes 16× MSAA very difficult to use while keeping a good framerate. 8× MSAA is hard enough to use as it is.
2021-05-25 16:25:10 +02:00
Multisample antialiasing uses 8 samples per pixel for 3D. This has a very high impact on performance. Likely unsupported on low-end and older hardware.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
Remove 16× MSAA support due to driver bugs and low performance In the `master` branch, 16× MSAA caused the entire system to freeze on NVIDIA GPUs. This is likely caused by graphics drivers not actually implementing 16× MSAA, but combining 8× MSAA with 2× SSAA instead. On top of that, modern shader complexity makes 16× MSAA very difficult to use while keeping a good framerate. 8× MSAA is hard enough to use as it is.
2021-05-25 16:25:10 +02:00
<constant name="VIEWPORT_MSAA_MAX" value="4" enum="ViewportMSAA">
doc: Sync classref with current source Add missing enum bindings.
2020-04-20 11:48:00 +02:00
</constant>
<constant name="VIEWPORT_SCREEN_SPACE_AA_DISABLED" value="0" enum="ViewportScreenSpaceAA">
</constant>
<constant name="VIEWPORT_SCREEN_SPACE_AA_FXAA" value="1" enum="ViewportScreenSpaceAA">
</constant>
<constant name="VIEWPORT_SCREEN_SPACE_AA_MAX" value="2" enum="ViewportScreenSpaceAA">
</constant>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<constant name="VIEWPORT_OCCLUSION_BUILD_QUALITY_LOW" value="0" enum="ViewportOcclusionCullingBuildQuality">
</constant>
<constant name="VIEWPORT_OCCLUSION_BUILD_QUALITY_MEDIUM" value="1" enum="ViewportOcclusionCullingBuildQuality">
</constant>
<constant name="VIEWPORT_OCCLUSION_BUILD_QUALITY_HIGH" value="2" enum="ViewportOcclusionCullingBuildQuality">
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="VIEWPORT_RENDER_INFO_OBJECTS_IN_FRAME" value="0" enum="ViewportRenderInfo">
Finish documenting VisualServer
2020-01-06 00:36:50 +01:00
Number of objects drawn in a single frame.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
Fix Render Info * Fixed and redone the process to obtain render information from a viewport * Some stats, such as material changes are too difficult to guess on Vulkan, were removed. * Separated visible and shadow stats, which causes confusion. * Texture, buffer and general video memory can be queried now. * Fixed the performance metrics too.
2021-07-03 01:14:19 +02:00
<constant name="VIEWPORT_RENDER_INFO_PRIMITIVES_IN_FRAME" value="1" enum="ViewportRenderInfo">
Finish documenting VisualServer
2020-01-06 00:36:50 +01:00
Number of vertices drawn in a single frame.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
Fix Render Info * Fixed and redone the process to obtain render information from a viewport * Some stats, such as material changes are too difficult to guess on Vulkan, were removed. * Separated visible and shadow stats, which causes confusion. * Texture, buffer and general video memory can be queried now. * Fixed the performance metrics too.
2021-07-03 01:14:19 +02:00
<constant name="VIEWPORT_RENDER_INFO_DRAW_CALLS_IN_FRAME" value="2" enum="ViewportRenderInfo">
Number of draw calls during this frame.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
Fix Render Info * Fixed and redone the process to obtain render information from a viewport * Some stats, such as material changes are too difficult to guess on Vulkan, were removed. * Separated visible and shadow stats, which causes confusion. * Texture, buffer and general video memory can be queried now. * Fixed the performance metrics too.
2021-07-03 01:14:19 +02:00
<constant name="VIEWPORT_RENDER_INFO_MAX" value="3" enum="ViewportRenderInfo">
Represents the size of the [enum ViewportRenderInfo] enum.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
Fix Render Info * Fixed and redone the process to obtain render information from a viewport * Some stats, such as material changes are too difficult to guess on Vulkan, were removed. * Separated visible and shadow stats, which causes confusion. * Texture, buffer and general video memory can be queried now. * Fixed the performance metrics too.
2021-07-03 01:14:19 +02:00
<constant name="VIEWPORT_RENDER_INFO_TYPE_VISIBLE" value="0" enum="ViewportRenderInfoType">
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
Fix Render Info * Fixed and redone the process to obtain render information from a viewport * Some stats, such as material changes are too difficult to guess on Vulkan, were removed. * Separated visible and shadow stats, which causes confusion. * Texture, buffer and general video memory can be queried now. * Fixed the performance metrics too.
2021-07-03 01:14:19 +02:00
<constant name="VIEWPORT_RENDER_INFO_TYPE_SHADOW" value="1" enum="ViewportRenderInfoType">
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
Fix Render Info * Fixed and redone the process to obtain render information from a viewport * Some stats, such as material changes are too difficult to guess on Vulkan, were removed. * Separated visible and shadow stats, which causes confusion. * Texture, buffer and general video memory can be queried now. * Fixed the performance metrics too.
2021-07-03 01:14:19 +02:00
<constant name="VIEWPORT_RENDER_INFO_TYPE_MAX" value="2" enum="ViewportRenderInfoType">
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="VIEWPORT_DEBUG_DRAW_DISABLED" value="0" enum="ViewportDebugDraw">
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Debug draw is disabled. Default setting.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="VIEWPORT_DEBUG_DRAW_UNSHADED" value="1" enum="ViewportDebugDraw">
Update many docs with recent rendering changes
2020-04-17 01:05:25 +02:00
Objects are displayed without light information.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 09:59:06 +01:00
<constant name="VIEWPORT_DEBUG_DRAW_LIGHTING" value="2" enum="ViewportDebugDraw">
Update many docs with recent rendering changes
2020-04-17 01:05:25 +02:00
Objects are displayed with only light information.
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 09:59:06 +01:00
</constant>
<constant name="VIEWPORT_DEBUG_DRAW_OVERDRAW" value="3" enum="ViewportDebugDraw">
Document that vertex displacement isn't visible in overdraw debug mode See #24232.
2020-11-22 16:28:00 +01:00
Objects are displayed semi-transparent with additive blending so you can see where they are drawing over top of one another. A higher overdraw (represented by brighter colors) means you are wasting performance on drawing pixels that are being hidden behind others.
[b]Note:[/b] When using this debug draw mode, custom shaders will be ignored. This means vertex displacement won't be visible anymore.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 09:59:06 +01:00
<constant name="VIEWPORT_DEBUG_DRAW_WIREFRAME" value="4" enum="ViewportDebugDraw">
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Debug draw draws objects in wireframe.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 09:59:06 +01:00
<constant name="VIEWPORT_DEBUG_DRAW_NORMAL_BUFFER" value="5" enum="ViewportDebugDraw">
Update many docs with recent rendering changes
2020-04-17 01:05:25 +02:00
Normal buffer is drawn instead of regular scene so you can see the per-pixel normals that will be used by post-processing effects.
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 09:59:06 +01:00
</constant>
Rename GI Classes * GIProbe is now VoxelGI * BakedLightmap is now LightmapGI As godot adds more ways to provide GI (as an example, SDFGI in 4.0), the different techniques (which have different pros/cons) need to be properly named to avoid confusion.
2021-06-05 00:47:26 +02:00
<constant name="VIEWPORT_DEBUG_DRAW_VOXEL_GI_ALBEDO" value="6" enum="ViewportDebugDraw">
Objects are displayed with only the albedo value from [VoxelGI]s.
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 09:59:06 +01:00
</constant>
Rename GI Classes * GIProbe is now VoxelGI * BakedLightmap is now LightmapGI As godot adds more ways to provide GI (as an example, SDFGI in 4.0), the different techniques (which have different pros/cons) need to be properly named to avoid confusion.
2021-06-05 00:47:26 +02:00
<constant name="VIEWPORT_DEBUG_DRAW_VOXEL_GI_LIGHTING" value="7" enum="ViewportDebugDraw">
Objects are displayed with only the lighting value from [VoxelGI]s.
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 09:59:06 +01:00
</constant>
Rename GI Classes * GIProbe is now VoxelGI * BakedLightmap is now LightmapGI As godot adds more ways to provide GI (as an example, SDFGI in 4.0), the different techniques (which have different pros/cons) need to be properly named to avoid confusion.
2021-06-05 00:47:26 +02:00
<constant name="VIEWPORT_DEBUG_DRAW_VOXEL_GI_EMISSION" value="8" enum="ViewportDebugDraw">
Objects are displayed with only the emission color from [VoxelGI]s.
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 09:59:06 +01:00
</constant>
<constant name="VIEWPORT_DEBUG_DRAW_SHADOW_ATLAS" value="9" enum="ViewportDebugDraw">
Update many docs with recent rendering changes
2020-04-17 01:05:25 +02:00
Draws the shadow atlas that stores shadows from [OmniLight3D]s and [SpotLight3D]s in the upper left quadrant of the [Viewport].
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 09:59:06 +01:00
</constant>
<constant name="VIEWPORT_DEBUG_DRAW_DIRECTIONAL_SHADOW_ATLAS" value="10" enum="ViewportDebugDraw">
Update many docs with recent rendering changes
2020-04-17 01:05:25 +02:00
Draws the shadow atlas that stores shadows from [DirectionalLight3D]s in the upper left quadrant of the [Viewport].
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 09:59:06 +01:00
</constant>
<constant name="VIEWPORT_DEBUG_DRAW_SCENE_LUMINANCE" value="11" enum="ViewportDebugDraw">
</constant>
<constant name="VIEWPORT_DEBUG_DRAW_SSAO" value="12" enum="ViewportDebugDraw">
Update many docs with recent rendering changes
2020-04-17 01:05:25 +02:00
Draws the screen space ambient occlusion texture instead of the scene so that you can clearly see how it is affecting objects. In order for this display mode to work, you must have [member Environment.ssao_enabled] set in your [WorldEnvironment].
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 09:59:06 +01:00
</constant>
Environment: Refactor code for readability + more - Makes all boolean setters/getters consistent. - Fixes bug where `glow_hdr_bleed_scale` was not used. - Split CameraEffects to their own source file. - Reorder all Environment method and properties declarations, definitions and bindings to be consistent with each other and with the order of property bindings. - Bind missing enum values added with SDFGI. - Remove unused SDFGI enhance_ssr boolean. - Sync doc changes after SDFGI merge and other misc changes.
2020-07-01 14:18:13 +02:00
<constant name="VIEWPORT_DEBUG_DRAW_PSSM_SPLITS" value="13" enum="ViewportDebugDraw">
Update many docs with recent rendering changes
2020-04-17 01:05:25 +02:00
Colors each PSSM split for the [DirectionalLight3D]s in the scene a different color so you can see where the splits are. In order they will be colored red, green, blue, yellow.
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 09:59:06 +01:00
</constant>
Environment: Refactor code for readability + more - Makes all boolean setters/getters consistent. - Fixes bug where `glow_hdr_bleed_scale` was not used. - Split CameraEffects to their own source file. - Reorder all Environment method and properties declarations, definitions and bindings to be consistent with each other and with the order of property bindings. - Bind missing enum values added with SDFGI. - Remove unused SDFGI enhance_ssr boolean. - Sync doc changes after SDFGI merge and other misc changes.
2020-07-01 14:18:13 +02:00
<constant name="VIEWPORT_DEBUG_DRAW_DECAL_ATLAS" value="14" enum="ViewportDebugDraw">
</constant>
<constant name="VIEWPORT_DEBUG_DRAW_SDFGI" value="15" enum="ViewportDebugDraw">
</constant>
<constant name="VIEWPORT_DEBUG_DRAW_SDFGI_PROBES" value="16" enum="ViewportDebugDraw">
</constant>
<constant name="VIEWPORT_DEBUG_DRAW_GI_BUFFER" value="17" enum="ViewportDebugDraw">
doc: Sync classref with current source Add missing enum bindings.
2020-04-20 11:48:00 +02:00
</constant>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<constant name="VIEWPORT_DEBUG_DRAW_DISABLE_LOD" value="18" enum="ViewportDebugDraw">
</constant>
<constant name="VIEWPORT_DEBUG_DRAW_CLUSTER_OMNI_LIGHTS" value="19" enum="ViewportDebugDraw">
</constant>
<constant name="VIEWPORT_DEBUG_DRAW_CLUSTER_SPOT_LIGHTS" value="20" enum="ViewportDebugDraw">
</constant>
<constant name="VIEWPORT_DEBUG_DRAW_CLUSTER_DECALS" value="21" enum="ViewportDebugDraw">
</constant>
<constant name="VIEWPORT_DEBUG_DRAW_CLUSTER_REFLECTION_PROBES" value="22" enum="ViewportDebugDraw">
</constant>
Implement occlusion culling Added an occlusion culling system with support for static occluder meshes. It can be enabled via `Project Settings > Rendering > Occlusion Culling > Use Occlusion Culling`. Occluders are defined via the new `Occluder3D` resource and instanced using the new `OccluderInstance3D` node. The occluders can also be automatically baked from a scene using the built-in editor plugin.
2021-04-20 18:40:24 +02:00
<constant name="VIEWPORT_DEBUG_DRAW_OCCLUDERS" value="23" enum="ViewportDebugDraw">
</constant>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<constant name="SKY_MODE_AUTOMATIC" value="0" enum="SkyMode">
</constant>
Add incremental update mode to sky
2020-07-11 02:07:30 +02:00
<constant name="SKY_MODE_QUALITY" value="1" enum="SkyMode">
doc: Sync classref with current source And fix various bogus bindings following previous PRs.
2021-02-19 13:35:31 +01:00
Uses high quality importance sampling to process the radiance map. In general, this results in much higher quality than [constant Sky.PROCESS_MODE_REALTIME] but takes much longer to generate. This should not be used if you plan on changing the sky at runtime. If you are finding that the reflection is not blurry enough and is showing sparkles or fireflies, try increasing [member ProjectSettings.rendering/reflections/sky_reflections/ggx_samples].
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 09:59:06 +01:00
</constant>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<constant name="SKY_MODE_INCREMENTAL" value="2" enum="SkyMode">
</constant>
Add incremental update mode to sky
2020-07-11 02:07:30 +02:00
<constant name="SKY_MODE_REALTIME" value="3" enum="SkyMode">
Update many docs with recent rendering changes
2020-04-17 01:05:25 +02:00
Uses the fast filtering algorithm to process the radiance map. In general this results in lower quality, but substantially faster run times.
[b]Note:[/b] The fast filtering algorithm is limited to 256x256 cubemaps, so [member Sky.radiance_size] must be set to [constant Sky.RADIANCE_SIZE_256].
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 09:59:06 +01:00
</constant>
<constant name="ENV_BG_CLEAR_COLOR" value="0" enum="EnvironmentBG">
Use the clear color as background.
</constant>
<constant name="ENV_BG_COLOR" value="1" enum="EnvironmentBG">
Use a specified color as the background.
</constant>
<constant name="ENV_BG_SKY" value="2" enum="EnvironmentBG">
Use a sky resource for the background.
</constant>
<constant name="ENV_BG_CANVAS" value="3" enum="EnvironmentBG">
Use a specified canvas layer as the background. This can be useful for instantiating a 2D scene in a 3D world.
</constant>
<constant name="ENV_BG_KEEP" value="4" enum="EnvironmentBG">
Do not clear the background, use whatever was rendered last frame as the background.
</constant>
<constant name="ENV_BG_CAMERA_FEED" value="5" enum="EnvironmentBG">
Displays a camera feed in the background.
</constant>
<constant name="ENV_BG_MAX" value="6" enum="EnvironmentBG">
Represents the size of the [enum EnvironmentBG] enum.
</constant>
<constant name="ENV_AMBIENT_SOURCE_BG" value="0" enum="EnvironmentAmbientSource">
Update many docs with recent rendering changes
2020-04-17 01:05:25 +02:00
Gather ambient light from whichever source is specified as the background.
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 09:59:06 +01:00
</constant>
<constant name="ENV_AMBIENT_SOURCE_DISABLED" value="1" enum="EnvironmentAmbientSource">
Update many docs with recent rendering changes
2020-04-17 01:05:25 +02:00
Disable ambient light.
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 09:59:06 +01:00
</constant>
<constant name="ENV_AMBIENT_SOURCE_COLOR" value="2" enum="EnvironmentAmbientSource">
Update many docs with recent rendering changes
2020-04-17 01:05:25 +02:00
Specify a specific [Color] for ambient light.
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 09:59:06 +01:00
</constant>
<constant name="ENV_AMBIENT_SOURCE_SKY" value="3" enum="EnvironmentAmbientSource">
Update many docs with recent rendering changes
2020-04-17 01:05:25 +02:00
Gather ambient light from the [Sky] regardless of what the background is.
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 09:59:06 +01:00
</constant>
<constant name="ENV_REFLECTION_SOURCE_BG" value="0" enum="EnvironmentReflectionSource">
Update many docs with recent rendering changes
2020-04-17 01:05:25 +02:00
Use the background for reflections.
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 09:59:06 +01:00
</constant>
<constant name="ENV_REFLECTION_SOURCE_DISABLED" value="1" enum="EnvironmentReflectionSource">
Update many docs with recent rendering changes
2020-04-17 01:05:25 +02:00
Disable reflections.
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 09:59:06 +01:00
</constant>
<constant name="ENV_REFLECTION_SOURCE_SKY" value="2" enum="EnvironmentReflectionSource">
Update many docs with recent rendering changes
2020-04-17 01:05:25 +02:00
Use the [Sky] for reflections regardless of what the background is.
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 09:59:06 +01:00
</constant>
<constant name="ENV_GLOW_BLEND_MODE_ADDITIVE" value="0" enum="EnvironmentGlowBlendMode">
Update many docs with recent rendering changes
2020-04-17 01:05:25 +02:00
Additive glow blending mode. Mostly used for particles, glows (bloom), lens flare, bright sources.
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 09:59:06 +01:00
</constant>
<constant name="ENV_GLOW_BLEND_MODE_SCREEN" value="1" enum="EnvironmentGlowBlendMode">
Update many docs with recent rendering changes
2020-04-17 01:05:25 +02:00
Screen glow blending mode. Increases brightness, used frequently with bloom.
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 09:59:06 +01:00
</constant>
<constant name="ENV_GLOW_BLEND_MODE_SOFTLIGHT" value="2" enum="EnvironmentGlowBlendMode">
Update many docs with recent rendering changes
2020-04-17 01:05:25 +02:00
Soft light glow blending mode. Modifies contrast, exposes shadows and highlights (vivid bloom).
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 09:59:06 +01:00
</constant>
<constant name="ENV_GLOW_BLEND_MODE_REPLACE" value="3" enum="EnvironmentGlowBlendMode">
Update many docs with recent rendering changes
2020-04-17 01:05:25 +02:00
Replace glow blending mode. Replaces all pixels' color by the glow value. This can be used to simulate a full-screen blur effect by tweaking the glow parameters to match the original image's brightness.
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 09:59:06 +01:00
</constant>
<constant name="ENV_GLOW_BLEND_MODE_MIX" value="4" enum="EnvironmentGlowBlendMode">
Update many docs with recent rendering changes
2020-04-17 01:05:25 +02:00
Mixes the glow with the underlying color to avoid increasing brightness as much while still maintaining a glow effect.
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 09:59:06 +01:00
</constant>
<constant name="ENV_TONE_MAPPER_LINEAR" value="0" enum="EnvironmentToneMapper">
Output color as they came in.
</constant>
<constant name="ENV_TONE_MAPPER_REINHARD" value="1" enum="EnvironmentToneMapper">
Use the Reinhard tonemapper.
</constant>
<constant name="ENV_TONE_MAPPER_FILMIC" value="2" enum="EnvironmentToneMapper">
Use the filmic tonemapper.
</constant>
<constant name="ENV_TONE_MAPPER_ACES" value="3" enum="EnvironmentToneMapper">
Use the ACES tonemapper.
</constant>
doc: Sync classref with current source Add missing enum bindings.
2020-04-20 11:48:00 +02:00
<constant name="ENV_SSR_ROUGNESS_QUALITY_DISABLED" value="0" enum="EnvironmentSSRRoughnessQuality">
</constant>
<constant name="ENV_SSR_ROUGNESS_QUALITY_LOW" value="1" enum="EnvironmentSSRRoughnessQuality">
</constant>
<constant name="ENV_SSR_ROUGNESS_QUALITY_MEDIUM" value="2" enum="EnvironmentSSRRoughnessQuality">
</constant>
<constant name="ENV_SSR_ROUGNESS_QUALITY_HIGH" value="3" enum="EnvironmentSSRRoughnessQuality">
</constant>
Port ASSAO to Godot to replace SAO
2020-12-08 06:37:09 +01:00
<constant name="ENV_SSAO_QUALITY_VERY_LOW" value="0" enum="EnvironmentSSAOQuality">
Revert "Replace SAO implementation with MSSAO"
2020-10-19 00:27:51 +02:00
Lowest quality of screen space ambient occlusion.
Fix VisualServer bindings.
2020-02-16 18:55:40 +01:00
</constant>
Port ASSAO to Godot to replace SAO
2020-12-08 06:37:09 +01:00
<constant name="ENV_SSAO_QUALITY_LOW" value="1" enum="EnvironmentSSAOQuality">
Low quality screen space ambient occlusion.
</constant>
<constant name="ENV_SSAO_QUALITY_MEDIUM" value="2" enum="EnvironmentSSAOQuality">
Revert "Replace SAO implementation with MSSAO"
2020-10-19 00:27:51 +02:00
Medium quality screen space ambient occlusion.
Fix VisualServer bindings.
2020-02-16 18:55:40 +01:00
</constant>
Port ASSAO to Godot to replace SAO
2020-12-08 06:37:09 +01:00
<constant name="ENV_SSAO_QUALITY_HIGH" value="3" enum="EnvironmentSSAOQuality">
Revert "Replace SAO implementation with MSSAO"
2020-10-19 00:27:51 +02:00
High quality screen space ambient occlusion.
Fix VisualServer bindings.
2020-02-16 18:55:40 +01:00
</constant>
Port ASSAO to Godot to replace SAO
2020-12-08 06:37:09 +01:00
<constant name="ENV_SSAO_QUALITY_ULTRA" value="4" enum="EnvironmentSSAOQuality">
Highest quality screen space ambient occlusion. Uses the adaptive setting which can be dynamically adjusted to smoothly balance performance and visual quality.
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 09:59:06 +01:00
</constant>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<constant name="ENV_SDFGI_CASCADES_4" value="0" enum="EnvironmentSDFGICascades">
doc: Sync classref with current source Add missing enum bindings.
2020-04-20 11:48:00 +02:00
</constant>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<constant name="ENV_SDFGI_CASCADES_6" value="1" enum="EnvironmentSDFGICascades">
doc: Sync classref with current source Add missing enum bindings.
2020-04-20 11:48:00 +02:00
</constant>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<constant name="ENV_SDFGI_CASCADES_8" value="2" enum="EnvironmentSDFGICascades">
doc: Sync classref with current source Add missing enum bindings.
2020-04-20 11:48:00 +02:00
</constant>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<constant name="ENV_SDFGI_Y_SCALE_DISABLED" value="0" enum="EnvironmentSDFGIYScale">
doc: Sync classref with current source Add missing enum bindings.
2020-04-20 11:48:00 +02:00
</constant>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<constant name="ENV_SDFGI_Y_SCALE_75_PERCENT" value="1" enum="EnvironmentSDFGIYScale">
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 09:59:06 +01:00
</constant>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<constant name="ENV_SDFGI_Y_SCALE_50_PERCENT" value="2" enum="EnvironmentSDFGIYScale">
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 09:59:06 +01:00
</constant>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<constant name="ENV_SDFGI_RAY_COUNT_4" value="0" enum="EnvironmentSDFGIRayCount">
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 09:59:06 +01:00
</constant>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<constant name="ENV_SDFGI_RAY_COUNT_8" value="1" enum="EnvironmentSDFGIRayCount">
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 09:59:06 +01:00
</constant>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<constant name="ENV_SDFGI_RAY_COUNT_16" value="2" enum="EnvironmentSDFGIRayCount">
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 09:59:06 +01:00
</constant>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<constant name="ENV_SDFGI_RAY_COUNT_32" value="3" enum="EnvironmentSDFGIRayCount">
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 09:59:06 +01:00
</constant>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<constant name="ENV_SDFGI_RAY_COUNT_64" value="4" enum="EnvironmentSDFGIRayCount">
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 09:59:06 +01:00
</constant>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<constant name="ENV_SDFGI_RAY_COUNT_96" value="5" enum="EnvironmentSDFGIRayCount">
doc: Sync classref with current source Add missing enum bindings.
2020-04-20 11:48:00 +02:00
</constant>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<constant name="ENV_SDFGI_RAY_COUNT_128" value="6" enum="EnvironmentSDFGIRayCount">
doc: Sync classref with current source Add missing enum bindings.
2020-04-20 11:48:00 +02:00
</constant>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<constant name="ENV_SDFGI_RAY_COUNT_MAX" value="7" enum="EnvironmentSDFGIRayCount">
doc: Sync classref with current source Add missing enum bindings.
2020-04-20 11:48:00 +02:00
</constant>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<constant name="ENV_SDFGI_CONVERGE_IN_5_FRAMES" value="0" enum="EnvironmentSDFGIFramesToConverge">
doc: Sync classref with current source Add missing enum bindings.
2020-04-20 11:48:00 +02:00
</constant>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<constant name="ENV_SDFGI_CONVERGE_IN_10_FRAMES" value="1" enum="EnvironmentSDFGIFramesToConverge">
doc: Sync classref with current source Add missing enum bindings.
2020-04-20 11:48:00 +02:00
</constant>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<constant name="ENV_SDFGI_CONVERGE_IN_15_FRAMES" value="2" enum="EnvironmentSDFGIFramesToConverge">
doc: Sync classref with current source Add missing enum bindings.
2020-04-20 11:48:00 +02:00
</constant>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<constant name="ENV_SDFGI_CONVERGE_IN_20_FRAMES" value="3" enum="EnvironmentSDFGIFramesToConverge">
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<constant name="ENV_SDFGI_CONVERGE_IN_25_FRAMES" value="4" enum="EnvironmentSDFGIFramesToConverge">
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<constant name="ENV_SDFGI_CONVERGE_IN_30_FRAMES" value="5" enum="EnvironmentSDFGIFramesToConverge">
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<constant name="ENV_SDFGI_CONVERGE_MAX" value="6" enum="EnvironmentSDFGIFramesToConverge">
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<constant name="ENV_SDFGI_UPDATE_LIGHT_IN_1_FRAME" value="0" enum="EnvironmentSDFGIFramesToUpdateLight">
Implement occlusion culling Added an occlusion culling system with support for static occluder meshes. It can be enabled via `Project Settings > Rendering > Occlusion Culling > Use Occlusion Culling`. Occluders are defined via the new `Occluder3D` resource and instanced using the new `OccluderInstance3D` node. The occluders can also be automatically baked from a scene using the built-in editor plugin.
2021-04-20 18:40:24 +02:00
</constant>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<constant name="ENV_SDFGI_UPDATE_LIGHT_IN_2_FRAMES" value="1" enum="EnvironmentSDFGIFramesToUpdateLight">
Implement occlusion culling Added an occlusion culling system with support for static occluder meshes. It can be enabled via `Project Settings > Rendering > Occlusion Culling > Use Occlusion Culling`. Occluders are defined via the new `Occluder3D` resource and instanced using the new `OccluderInstance3D` node. The occluders can also be automatically baked from a scene using the built-in editor plugin.
2021-04-20 18:40:24 +02:00
</constant>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<constant name="ENV_SDFGI_UPDATE_LIGHT_IN_4_FRAMES" value="2" enum="EnvironmentSDFGIFramesToUpdateLight">
</constant>
<constant name="ENV_SDFGI_UPDATE_LIGHT_IN_8_FRAMES" value="3" enum="EnvironmentSDFGIFramesToUpdateLight">
</constant>
<constant name="ENV_SDFGI_UPDATE_LIGHT_IN_16_FRAMES" value="4" enum="EnvironmentSDFGIFramesToUpdateLight">
</constant>
<constant name="ENV_SDFGI_UPDATE_LIGHT_MAX" value="5" enum="EnvironmentSDFGIFramesToUpdateLight">
</constant>
<constant name="SUB_SURFACE_SCATTERING_QUALITY_DISABLED" value="0" enum="SubSurfaceScatteringQuality">
</constant>
<constant name="SUB_SURFACE_SCATTERING_QUALITY_LOW" value="1" enum="SubSurfaceScatteringQuality">
</constant>
<constant name="SUB_SURFACE_SCATTERING_QUALITY_MEDIUM" value="2" enum="SubSurfaceScatteringQuality">
</constant>
<constant name="SUB_SURFACE_SCATTERING_QUALITY_HIGH" value="3" enum="SubSurfaceScatteringQuality">
</constant>
<constant name="DOF_BOKEH_BOX" value="0" enum="DOFBokehShape">
Calculate the DOF blur using a box filter. The fastest option, but results in obvious lines in blur pattern.
</constant>
<constant name="DOF_BOKEH_HEXAGON" value="1" enum="DOFBokehShape">
Calculates DOF blur using a hexagon shaped filter.
</constant>
<constant name="DOF_BOKEH_CIRCLE" value="2" enum="DOFBokehShape">
Calculates DOF blur using a circle shaped filter. Best quality and most realistic, but slowest. Use only for areas where a lot of performance can be dedicated to post-processing (e.g. cutscenes).
</constant>
<constant name="DOF_BLUR_QUALITY_VERY_LOW" value="0" enum="DOFBlurQuality">
Lowest quality DOF blur. This is the fastest setting, but you may be able to see filtering artifacts.
</constant>
<constant name="DOF_BLUR_QUALITY_LOW" value="1" enum="DOFBlurQuality">
Low quality DOF blur.
</constant>
<constant name="DOF_BLUR_QUALITY_MEDIUM" value="2" enum="DOFBlurQuality">
Medium quality DOF blur.
</constant>
<constant name="DOF_BLUR_QUALITY_HIGH" value="3" enum="DOFBlurQuality">
Highest quality DOF blur. Results in the smoothest looking blur by taking the most samples, but is also significantly slower.
Implement occlusion culling Added an occlusion culling system with support for static occluder meshes. It can be enabled via `Project Settings > Rendering > Occlusion Culling > Use Occlusion Culling`. Occluders are defined via the new `Occluder3D` resource and instanced using the new `OccluderInstance3D` node. The occluders can also be automatically baked from a scene using the built-in editor plugin.
2021-04-20 18:40:24 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="INSTANCE_NONE" value="0" enum="InstanceType">
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
The instance does not have a type.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="INSTANCE_MESH" value="1" enum="InstanceType">
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
The instance is a mesh.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="INSTANCE_MULTIMESH" value="2" enum="InstanceType">
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
The instance is a multimesh.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
Deprecate ImmediateGeometry * Removed entirely from RenderingServer. * Replaced by ImmediateMesh resource. * ImmediateMesh replaces ImmediateGeometry, but could use more optimization in the future. * Sprite3D and AnimatedSprite3D work again, ported from Godot 3.x (though a lot of work was needed to adapt them to Godot 4). * RootMotionView works again. * Polygon3D editor works again.
2021-06-30 03:55:11 +02:00
<constant name="INSTANCE_PARTICLES" value="3" enum="InstanceType">
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
The instance is a particle emitter.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
Deprecate ImmediateGeometry * Removed entirely from RenderingServer. * Replaced by ImmediateMesh resource. * ImmediateMesh replaces ImmediateGeometry, but could use more optimization in the future. * Sprite3D and AnimatedSprite3D work again, ported from Godot 3.x (though a lot of work was needed to adapt them to Godot 4). * RootMotionView works again. * Polygon3D editor works again.
2021-06-30 03:55:11 +02:00
<constant name="INSTANCE_PARTICLES_COLLISION" value="4" enum="InstanceType">
doc: Sync classref with current source
2020-10-12 10:57:54 +02:00
</constant>
Deprecate ImmediateGeometry * Removed entirely from RenderingServer. * Replaced by ImmediateMesh resource. * ImmediateMesh replaces ImmediateGeometry, but could use more optimization in the future. * Sprite3D and AnimatedSprite3D work again, ported from Godot 3.x (though a lot of work was needed to adapt them to Godot 4). * RootMotionView works again. * Polygon3D editor works again.
2021-06-30 03:55:11 +02:00
<constant name="INSTANCE_LIGHT" value="5" enum="InstanceType">
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
The instance is a light.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
Deprecate ImmediateGeometry * Removed entirely from RenderingServer. * Replaced by ImmediateMesh resource. * ImmediateMesh replaces ImmediateGeometry, but could use more optimization in the future. * Sprite3D and AnimatedSprite3D work again, ported from Godot 3.x (though a lot of work was needed to adapt them to Godot 4). * RootMotionView works again. * Polygon3D editor works again.
2021-06-30 03:55:11 +02:00
<constant name="INSTANCE_REFLECTION_PROBE" value="6" enum="InstanceType">
Document most VisualServer functions
2020-01-05 09:33:16 +01:00
The instance is a reflection probe.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
Deprecate ImmediateGeometry * Removed entirely from RenderingServer. * Replaced by ImmediateMesh resource. * ImmediateMesh replaces ImmediateGeometry, but could use more optimization in the future. * Sprite3D and AnimatedSprite3D work again, ported from Godot 3.x (though a lot of work was needed to adapt them to Godot 4). * RootMotionView works again. * Polygon3D editor works again.
2021-06-30 03:55:11 +02:00
<constant name="INSTANCE_DECAL" value="7" enum="InstanceType">
doc: Sync classref with current source Add missing enum bindings.
2020-04-20 11:48:00 +02:00
The instance is a decal.
</constant>
Deprecate ImmediateGeometry * Removed entirely from RenderingServer. * Replaced by ImmediateMesh resource. * ImmediateMesh replaces ImmediateGeometry, but could use more optimization in the future. * Sprite3D and AnimatedSprite3D work again, ported from Godot 3.x (though a lot of work was needed to adapt them to Godot 4). * RootMotionView works again. * Polygon3D editor works again.
2021-06-30 03:55:11 +02:00
<constant name="INSTANCE_VOXEL_GI" value="8" enum="InstanceType">
Rename GI Classes * GIProbe is now VoxelGI * BakedLightmap is now LightmapGI As godot adds more ways to provide GI (as an example, SDFGI in 4.0), the different techniques (which have different pros/cons) need to be properly named to avoid confusion.
2021-06-05 00:47:26 +02:00
The instance is a VoxelGI.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
Deprecate ImmediateGeometry * Removed entirely from RenderingServer. * Replaced by ImmediateMesh resource. * ImmediateMesh replaces ImmediateGeometry, but could use more optimization in the future. * Sprite3D and AnimatedSprite3D work again, ported from Godot 3.x (though a lot of work was needed to adapt them to Godot 4). * RootMotionView works again. * Polygon3D editor works again.
2021-06-30 03:55:11 +02:00
<constant name="INSTANCE_LIGHTMAP" value="9" enum="InstanceType">
doc: Sync classref with current source Adds API changes from the new GPU lightmapper.
2020-05-12 10:10:34 +02:00
The instance is a lightmap.
Bind TextEdit.deselect and update documentation
2017-12-16 20:34:16 +01:00
</constant>
Deprecate ImmediateGeometry * Removed entirely from RenderingServer. * Replaced by ImmediateMesh resource. * ImmediateMesh replaces ImmediateGeometry, but could use more optimization in the future. * Sprite3D and AnimatedSprite3D work again, ported from Godot 3.x (though a lot of work was needed to adapt them to Godot 4). * RootMotionView works again. * Polygon3D editor works again.
2021-06-30 03:55:11 +02:00
<constant name="INSTANCE_OCCLUDER" value="10" enum="InstanceType">
Implement occlusion culling Added an occlusion culling system with support for static occluder meshes. It can be enabled via `Project Settings > Rendering > Occlusion Culling > Use Occlusion Culling`. Occluders are defined via the new `Occluder3D` resource and instanced using the new `OccluderInstance3D` node. The occluders can also be automatically baked from a scene using the built-in editor plugin.
2021-04-20 18:40:24 +02:00
</constant>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<constant name="INSTANCE_VISIBLITY_NOTIFIER" value="11" enum="InstanceType">
</constant>
Addition of FogVolumes, FogShaders, FogMaterial, and overhaul of VolumetricFog Co-authored-by: Brian Semrau <brian.semrau@gmail.com>
2021-10-03 13:28:55 +02:00
<constant name="INSTANCE_FOG_VOLUME" value="12" enum="InstanceType">
</constant>
<constant name="INSTANCE_MAX" value="13" enum="InstanceType">
doc: Complete and harmonize all _MAX constant descriptions
2019-06-27 11:10:53 +02:00
Represents the size of the [enum InstanceType] enum.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
Deprecate ImmediateGeometry * Removed entirely from RenderingServer. * Replaced by ImmediateMesh resource. * ImmediateMesh replaces ImmediateGeometry, but could use more optimization in the future. * Sprite3D and AnimatedSprite3D work again, ported from Godot 3.x (though a lot of work was needed to adapt them to Godot 4). * RootMotionView works again. * Polygon3D editor works again.
2021-06-30 03:55:11 +02:00
<constant name="INSTANCE_GEOMETRY_MASK" value="14" enum="InstanceType">
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
A combination of the flags of geometry instances (mesh, multimesh, immediate and particles).
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<constant name="INSTANCE_FLAG_USE_BAKED_LIGHT" value="0" enum="InstanceFlags">
Updated many VisualServer functions
2020-01-04 08:24:40 +01:00
Allows the instance to be used in baked lighting.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</constant>
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 09:59:06 +01:00
<constant name="INSTANCE_FLAG_USE_DYNAMIC_GI" value="1" enum="InstanceFlags">
doc: Sync classref with current source Add missing enum bindings.
2020-04-20 11:48:00 +02:00
Allows the instance to be used with dynamic global illumination.
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 09:59:06 +01:00
</constant>
<constant name="INSTANCE_FLAG_DRAW_NEXT_FRAME_IF_VISIBLE" value="2" enum="InstanceFlags">
Updated many VisualServer functions
2020-01-04 08:24:40 +01:00
When set, manually requests to draw geometry on next frame.
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
</constant>
Implement occlusion culling Added an occlusion culling system with support for static occluder meshes. It can be enabled via `Project Settings > Rendering > Occlusion Culling > Use Occlusion Culling`. Occluders are defined via the new `Occluder3D` resource and instanced using the new `OccluderInstance3D` node. The occluders can also be automatically baked from a scene using the built-in editor plugin.
2021-04-20 18:40:24 +02:00
<constant name="INSTANCE_FLAG_IGNORE_OCCLUSION_CULLING" value="3" enum="InstanceFlags">
</constant>
<constant name="INSTANCE_FLAG_MAX" value="4" enum="InstanceFlags">
doc: Complete and harmonize all _MAX constant descriptions
2019-06-27 11:10:53 +02:00
Represents the size of the [enum InstanceFlags] enum.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</constant>
<constant name="SHADOW_CASTING_SETTING_OFF" value="0" enum="ShadowCastingSetting">
Updated many VisualServer functions
2020-01-04 08:24:40 +01:00
Disable shadows from this instance.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</constant>
<constant name="SHADOW_CASTING_SETTING_ON" value="1" enum="ShadowCastingSetting">
Updated many VisualServer functions
2020-01-04 08:24:40 +01:00
Cast shadows from this instance.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</constant>
<constant name="SHADOW_CASTING_SETTING_DOUBLE_SIDED" value="2" enum="ShadowCastingSetting">
Updated many VisualServer functions
2020-01-04 08:24:40 +01:00
Disable backface culling when rendering the shadow of the object. This is slightly slower but may result in more correct shadows.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</constant>
<constant name="SHADOW_CASTING_SETTING_SHADOWS_ONLY" value="3" enum="ShadowCastingSetting">
Updated many VisualServer functions
2020-01-04 08:24:40 +01:00
Only render the shadows from the object. The object itself will not be drawn.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</constant>
Implement distance fade and transparency The built-in ALPHA in spatial shaders comes pre-set with a per-instance transparency value. Multiply by it if you want to keep it. The transparency value of any given GeometryInstance3D is affected by: - Its new "transparency" property. - Its own visiblity range when the new "visibility_range_fade_mode" property is set to "Self". - Its parent visibility range when the parent's fade mode is set to "Dependencies". The "Self" mode will fade-out the instance when reaching the visibility range limits, while the "Dependencies" mode will fade-in its dependencies. Per-instance transparency is only implemented in the forward clustered renderer, support for mobile should be added in the future. Co-authored-by: reduz <reduzio@gmail.com>
2021-07-20 20:17:34 +02:00
<constant name="VISIBILITY_RANGE_FADE_DISABLED" value="0" enum="VisibilityRangeFadeMode">
Disable visibility range fading for the given instance.
</constant>
<constant name="VISIBILITY_RANGE_FADE_SELF" value="1" enum="VisibilityRangeFadeMode">
Fade-out the given instance when it approaches its visibility range limits.
</constant>
<constant name="VISIBILITY_RANGE_FADE_DEPENDENCIES" value="2" enum="VisibilityRangeFadeMode">
Fade-in the given instance's dependencies when reaching its visibility range limits.
</constant>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 04:17:47 +02:00
<constant name="BAKE_CHANNEL_ALBEDO_ALPHA" value="0" enum="BakeChannels">
</constant>
<constant name="BAKE_CHANNEL_NORMAL" value="1" enum="BakeChannels">
</constant>
<constant name="BAKE_CHANNEL_ORM" value="2" enum="BakeChannels">
</constant>
<constant name="BAKE_CHANNEL_EMISSION" value="3" enum="BakeChannels">
</constant>
<constant name="CANVAS_TEXTURE_CHANNEL_DIFFUSE" value="0" enum="CanvasTextureChannel">
</constant>
<constant name="CANVAS_TEXTURE_CHANNEL_NORMAL" value="1" enum="CanvasTextureChannel">
</constant>
<constant name="CANVAS_TEXTURE_CHANNEL_SPECULAR" value="2" enum="CanvasTextureChannel">
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="NINE_PATCH_STRETCH" value="0" enum="NinePatchAxisMode">
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
The nine patch gets stretched where needed.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="NINE_PATCH_TILE" value="1" enum="NinePatchAxisMode">
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
The nine patch gets filled with tiles where needed.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="NINE_PATCH_TILE_FIT" value="2" enum="NinePatchAxisMode">
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
The nine patch gets filled with tiles where needed and stretches them a bit if needed.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 09:59:06 +01:00
<constant name="CANVAS_ITEM_TEXTURE_FILTER_DEFAULT" value="0" enum="CanvasItemTextureFilter">
Update many docs with recent rendering changes
2020-04-17 01:05:25 +02:00
Uses the default filter mode for this [Viewport].
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 09:59:06 +01:00
</constant>
<constant name="CANVAS_ITEM_TEXTURE_FILTER_NEAREST" value="1" enum="CanvasItemTextureFilter">
Update many docs with recent rendering changes
2020-04-17 01:05:25 +02:00
The texture filter reads from the nearest pixel only. The simplest and fastest method of filtering, but the texture will look pixelized.
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 09:59:06 +01:00
</constant>
<constant name="CANVAS_ITEM_TEXTURE_FILTER_LINEAR" value="2" enum="CanvasItemTextureFilter">
Update many docs with recent rendering changes
2020-04-17 01:05:25 +02:00
The texture filter blends between the nearest 4 pixels. Use this when you want to avoid a pixelated style, but do not want mipmaps.
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 09:59:06 +01:00
</constant>
Fix MIMPAMPS typos in constants throughout the engine
2020-02-20 00:31:43 +01:00
<constant name="CANVAS_ITEM_TEXTURE_FILTER_NEAREST_WITH_MIPMAPS" value="3" enum="CanvasItemTextureFilter">
Update many docs with recent rendering changes
2020-04-17 01:05:25 +02:00
The texture filter reads from the nearest pixel in the nearest mipmap. The fastest way to read from textures with mipmaps.
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 09:59:06 +01:00
</constant>
<constant name="CANVAS_ITEM_TEXTURE_FILTER_LINEAR_WITH_MIPMAPS" value="4" enum="CanvasItemTextureFilter">
Update many docs with recent rendering changes
2020-04-17 01:05:25 +02:00
The texture filter blends between the nearest 4 pixels and between the nearest 2 mipmaps.
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 09:59:06 +01:00
</constant>
Fix MIMPAMPS typos in constants throughout the engine
2020-02-20 00:31:43 +01:00
<constant name="CANVAS_ITEM_TEXTURE_FILTER_NEAREST_WITH_MIPMAPS_ANISOTROPIC" value="5" enum="CanvasItemTextureFilter">
Update many docs with recent rendering changes
2020-04-17 01:05:25 +02:00
The texture filter reads from the nearest pixel, but selects a mipmap based on the angle between the surface and the camera view. This reduces artifacts on surfaces that are almost in line with the camera.
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 09:59:06 +01:00
</constant>
<constant name="CANVAS_ITEM_TEXTURE_FILTER_LINEAR_WITH_MIPMAPS_ANISOTROPIC" value="6" enum="CanvasItemTextureFilter">
Update many docs with recent rendering changes
2020-04-17 01:05:25 +02:00
The texture filter blends between the nearest 4 pixels and selects a mipmap based on the angle between the surface and the camera view. This reduces artifacts on surfaces that are almost in line with the camera. This is the slowest of the filtering options, but results in the highest quality texturing.
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 09:59:06 +01:00
</constant>
<constant name="CANVAS_ITEM_TEXTURE_FILTER_MAX" value="7" enum="CanvasItemTextureFilter">
Update many docs with recent rendering changes
2020-04-17 01:05:25 +02:00
Max value for [enum CanvasItemTextureFilter] enum.
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 09:59:06 +01:00
</constant>
<constant name="CANVAS_ITEM_TEXTURE_REPEAT_DEFAULT" value="0" enum="CanvasItemTextureRepeat">
Update many docs with recent rendering changes
2020-04-17 01:05:25 +02:00
Uses the default repeat mode for this [Viewport].
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 09:59:06 +01:00
</constant>
<constant name="CANVAS_ITEM_TEXTURE_REPEAT_DISABLED" value="1" enum="CanvasItemTextureRepeat">
Update many docs with recent rendering changes
2020-04-17 01:05:25 +02:00
Disables textures repeating. Instead, when reading UVs outside the 0-1 range, the value will be clamped to the edge of the texture, resulting in a stretched out look at the borders of the texture.
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 09:59:06 +01:00
</constant>
<constant name="CANVAS_ITEM_TEXTURE_REPEAT_ENABLED" value="2" enum="CanvasItemTextureRepeat">
Update many docs with recent rendering changes
2020-04-17 01:05:25 +02:00
Enables the texture to repeat when UV coordinates are outside the 0-1 range. If using one of the linear filtering modes, this can result in artifacts at the edges of a texture when the sampler filters across the edges of the texture.
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 09:59:06 +01:00
</constant>
<constant name="CANVAS_ITEM_TEXTURE_REPEAT_MIRROR" value="3" enum="CanvasItemTextureRepeat">
Update many docs with recent rendering changes
2020-04-17 01:05:25 +02:00
Flip the texture when repeating so that the edge lines up instead of abruptly changing.
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 09:59:06 +01:00
</constant>
<constant name="CANVAS_ITEM_TEXTURE_REPEAT_MAX" value="4" enum="CanvasItemTextureRepeat">
Update many docs with recent rendering changes
2020-04-17 01:05:25 +02:00
Max value for [enum CanvasItemTextureRepeat] enum.
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 09:59:06 +01:00
</constant>
doc: Sync classref with current source + fixup some bindings Includes various changes triggered by the refactoring of method bindings.
2020-11-04 15:38:26 +01:00
<constant name="CANVAS_GROUP_MODE_DISABLED" value="0" enum="CanvasGroupMode">
</constant>
<constant name="CANVAS_GROUP_MODE_OPAQUE" value="1" enum="CanvasGroupMode">
</constant>
<constant name="CANVAS_GROUP_MODE_TRANSPARENT" value="2" enum="CanvasGroupMode">
</constant>
<constant name="CANVAS_LIGHT_MODE_POINT" value="0" enum="CanvasLightMode">
</constant>
<constant name="CANVAS_LIGHT_MODE_DIRECTIONAL" value="1" enum="CanvasLightMode">
</constant>
<constant name="CANVAS_LIGHT_BLEND_MODE_ADD" value="0" enum="CanvasLightBlendMode">
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Adds light color additive to the canvas.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Sync classref with current source + fixup some bindings Includes various changes triggered by the refactoring of method bindings.
2020-11-04 15:38:26 +01:00
<constant name="CANVAS_LIGHT_BLEND_MODE_SUB" value="1" enum="CanvasLightBlendMode">
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Adds light color subtractive to the canvas.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Sync classref with current source + fixup some bindings Includes various changes triggered by the refactoring of method bindings.
2020-11-04 15:38:26 +01:00
<constant name="CANVAS_LIGHT_BLEND_MODE_MIX" value="2" enum="CanvasLightBlendMode">
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
The light adds color depending on transparency.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="CANVAS_LIGHT_FILTER_NONE" value="0" enum="CanvasLightShadowFilter">
Finish documenting VisualServer
2020-01-06 00:36:50 +01:00
Do not apply a filter to canvas light shadows.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 09:59:06 +01:00
<constant name="CANVAS_LIGHT_FILTER_PCF5" value="1" enum="CanvasLightShadowFilter">
Finish documenting VisualServer
2020-01-06 00:36:50 +01:00
Use PCF5 filtering to filter canvas light shadows.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 09:59:06 +01:00
<constant name="CANVAS_LIGHT_FILTER_PCF13" value="2" enum="CanvasLightShadowFilter">
Finish documenting VisualServer
2020-01-06 00:36:50 +01:00
Use PCF13 filtering to filter canvas light shadows.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 09:59:06 +01:00
<constant name="CANVAS_LIGHT_FILTER_MAX" value="3" enum="CanvasLightShadowFilter">
Update many docs with recent rendering changes
2020-04-17 01:05:25 +02:00
Max value of the [enum CanvasLightShadowFilter] enum.
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 09:59:06 +01:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="CANVAS_OCCLUDER_POLYGON_CULL_DISABLED" value="0" enum="CanvasOccluderPolygonCullMode">
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Culling of the canvas occluder is disabled.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="CANVAS_OCCLUDER_POLYGON_CULL_CLOCKWISE" value="1" enum="CanvasOccluderPolygonCullMode">
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Culling of the canvas occluder is clockwise.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="CANVAS_OCCLUDER_POLYGON_CULL_COUNTER_CLOCKWISE" value="2" enum="CanvasOccluderPolygonCullMode">
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Culling of the canvas occluder is counterclockwise.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Sync classref with current source Add missing enum bindings.
2020-04-20 11:48:00 +02:00
<constant name="GLOBAL_VAR_TYPE_BOOL" value="0" enum="GlobalVariableType">
</constant>
<constant name="GLOBAL_VAR_TYPE_BVEC2" value="1" enum="GlobalVariableType">
</constant>
<constant name="GLOBAL_VAR_TYPE_BVEC3" value="2" enum="GlobalVariableType">
</constant>
<constant name="GLOBAL_VAR_TYPE_BVEC4" value="3" enum="GlobalVariableType">
</constant>
<constant name="GLOBAL_VAR_TYPE_INT" value="4" enum="GlobalVariableType">
</constant>
<constant name="GLOBAL_VAR_TYPE_IVEC2" value="5" enum="GlobalVariableType">
</constant>
<constant name="GLOBAL_VAR_TYPE_IVEC3" value="6" enum="GlobalVariableType">
</constant>
<constant name="GLOBAL_VAR_TYPE_IVEC4" value="7" enum="GlobalVariableType">
</constant>
<constant name="GLOBAL_VAR_TYPE_RECT2I" value="8" enum="GlobalVariableType">
</constant>
<constant name="GLOBAL_VAR_TYPE_UINT" value="9" enum="GlobalVariableType">
</constant>
<constant name="GLOBAL_VAR_TYPE_UVEC2" value="10" enum="GlobalVariableType">
</constant>
<constant name="GLOBAL_VAR_TYPE_UVEC3" value="11" enum="GlobalVariableType">
</constant>
<constant name="GLOBAL_VAR_TYPE_UVEC4" value="12" enum="GlobalVariableType">
</constant>
<constant name="GLOBAL_VAR_TYPE_FLOAT" value="13" enum="GlobalVariableType">
</constant>
<constant name="GLOBAL_VAR_TYPE_VEC2" value="14" enum="GlobalVariableType">
</constant>
<constant name="GLOBAL_VAR_TYPE_VEC3" value="15" enum="GlobalVariableType">
</constant>
<constant name="GLOBAL_VAR_TYPE_VEC4" value="16" enum="GlobalVariableType">
</constant>
<constant name="GLOBAL_VAR_TYPE_COLOR" value="17" enum="GlobalVariableType">
</constant>
<constant name="GLOBAL_VAR_TYPE_RECT2" value="18" enum="GlobalVariableType">
</constant>
<constant name="GLOBAL_VAR_TYPE_MAT2" value="19" enum="GlobalVariableType">
</constant>
<constant name="GLOBAL_VAR_TYPE_MAT3" value="20" enum="GlobalVariableType">
</constant>
<constant name="GLOBAL_VAR_TYPE_MAT4" value="21" enum="GlobalVariableType">
</constant>
<constant name="GLOBAL_VAR_TYPE_TRANSFORM_2D" value="22" enum="GlobalVariableType">
</constant>
<constant name="GLOBAL_VAR_TYPE_TRANSFORM" value="23" enum="GlobalVariableType">
</constant>
<constant name="GLOBAL_VAR_TYPE_SAMPLER2D" value="24" enum="GlobalVariableType">
</constant>
<constant name="GLOBAL_VAR_TYPE_SAMPLER2DARRAY" value="25" enum="GlobalVariableType">
</constant>
<constant name="GLOBAL_VAR_TYPE_SAMPLER3D" value="26" enum="GlobalVariableType">
</constant>
<constant name="GLOBAL_VAR_TYPE_SAMPLERCUBE" value="27" enum="GlobalVariableType">
</constant>
<constant name="GLOBAL_VAR_TYPE_MAX" value="28" enum="GlobalVariableType">
</constant>
Fix Render Info * Fixed and redone the process to obtain render information from a viewport * Some stats, such as material changes are too difficult to guess on Vulkan, were removed. * Separated visible and shadow stats, which causes confusion. * Texture, buffer and general video memory can be queried now. * Fixed the performance metrics too.
2021-07-03 01:14:19 +02:00
<constant name="RENDERING_INFO_TOTAL_OBJECTS_IN_FRAME" value="0" enum="RenderingInfo">
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
Fix Render Info * Fixed and redone the process to obtain render information from a viewport * Some stats, such as material changes are too difficult to guess on Vulkan, were removed. * Separated visible and shadow stats, which causes confusion. * Texture, buffer and general video memory can be queried now. * Fixed the performance metrics too.
2021-07-03 01:14:19 +02:00
<constant name="RENDERING_INFO_TOTAL_PRIMITIVES_IN_FRAME" value="1" enum="RenderingInfo">
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
Fix Render Info * Fixed and redone the process to obtain render information from a viewport * Some stats, such as material changes are too difficult to guess on Vulkan, were removed. * Separated visible and shadow stats, which causes confusion. * Texture, buffer and general video memory can be queried now. * Fixed the performance metrics too.
2021-07-03 01:14:19 +02:00
<constant name="RENDERING_INFO_TOTAL_DRAW_CALLS_IN_FRAME" value="2" enum="RenderingInfo">
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
Fix Render Info * Fixed and redone the process to obtain render information from a viewport * Some stats, such as material changes are too difficult to guess on Vulkan, were removed. * Separated visible and shadow stats, which causes confusion. * Texture, buffer and general video memory can be queried now. * Fixed the performance metrics too.
2021-07-03 01:14:19 +02:00
<constant name="RENDERING_INFO_TEXTURE_MEM_USED" value="3" enum="RenderingInfo">
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
Fix Render Info * Fixed and redone the process to obtain render information from a viewport * Some stats, such as material changes are too difficult to guess on Vulkan, were removed. * Separated visible and shadow stats, which causes confusion. * Texture, buffer and general video memory can be queried now. * Fixed the performance metrics too.
2021-07-03 01:14:19 +02:00
<constant name="RENDERING_INFO_BUFFER_MEM_USED" value="4" enum="RenderingInfo">
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
Fix Render Info * Fixed and redone the process to obtain render information from a viewport * Some stats, such as material changes are too difficult to guess on Vulkan, were removed. * Separated visible and shadow stats, which causes confusion. * Texture, buffer and general video memory can be queried now. * Fixed the performance metrics too.
2021-07-03 01:14:19 +02:00
<constant name="RENDERING_INFO_VIDEO_MEM_USED" value="5" enum="RenderingInfo">
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="FEATURE_SHADERS" value="0" enum="Features">
Finish documenting VisualServer
2020-01-06 00:36:50 +01:00
Hardware supports shaders. This enum is currently unused in Godot 3.x.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="FEATURE_MULTITHREADED" value="1" enum="Features">
Finish documenting VisualServer
2020-01-06 00:36:50 +01:00
Hardware supports multithreading. This enum is currently unused in Godot 3.x.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</constants>
doc: Sync classref with current source
2017-12-10 00:43:30 +01:00
</class>
Reference in a new issue Copy permalink