godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
godot/doc/classes/RenderingServer.xml

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

4737 lines
215 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 20:42:36 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
Add an XML schema for documentation This makes it easier to spot syntax errors when editing the class reference. The schema is referenced locally so validation can still work offline. Each class XML's schema conformance is also checked on GitHub Actions.
2022-02-14 13:18:53 +00:00
<class name="RenderingServer" inherits="Object" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
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 20:42:36 +00:00
<brief_description>
Server for anything visible.
</brief_description>
<description>
Update many docs with recent rendering changes
2020-04-16 23:05:25 +00: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-05 23:36:50 +00: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 14:55:01 +00: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 11:04:28 +00:00
Similarly, in 2D, a canvas is needed to draw all canvas items.
Finish documenting VisualServer
2020-01-05 23:36:50 +00: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.
Document the DisplayServer class This also adds a link to the Command line tutorial on pages that reference command line arguments, as the page covers some general usage tips for CLI arguments (especially on macOS).
2022-10-26 18:45:23 +00:00
[b]Headless mode:[/b] Starting the engine with the [code]--headless[/code] [url=$DOCS_URL/tutorials/editor/command_line_tutorial.html]command line argument[/url] disables all rendering and window management functions. Most functions from [RenderingServer] will return dummy values in this case.
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 20:42:36 +00:00
</description>
<tutorials>
Replace Godot docs URL with `$DOCS_URL` in XML class reference
2021-11-15 09:43:07 +00:00
<link title="Optimization using Servers">$DOCS_URL/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 20:42:36 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="Image[]" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="base" type="RID" />
Change Array arguments to TypedArray
2022-08-31 17:24:04 +00:00
<param index="1" name="material_overrides" type="RID[]" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param 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 02:17:47 +00:00
<description>
</description>
</method>
Implement Physical Light Units as an optional setting. This allows light sources to be specified in physical light units in addition to the regular energy multiplier. In order to avoid loss of precision at high values, brightness values are premultiplied by an exposure normalization value. In support of Physical Light Units this PR also renames CameraEffects to CameraAttributes.
2022-07-31 23:20:24 +00:00
<method name="camera_attributes_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 13:28:05 +00: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 02:17:47 +00:00
<description>
Implement Physical Light Units as an optional setting. This allows light sources to be specified in physical light units in addition to the regular energy multiplier. In order to avoid loss of precision at high values, brightness values are premultiplied by an exposure normalization value. In support of Physical Light Units this PR also renames CameraEffects to CameraAttributes.
2022-07-31 23:20:24 +00:00
Creates a camera attributes object and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all [code]camera_attributes_[/code] RenderingServer functions.
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 02:17:47 +00:00
Once finished with your RID, you will want to free the RID using the RenderingServer's [method free_rid] static method.
</description>
</method>
Implement Physical Light Units as an optional setting. This allows light sources to be specified in physical light units in addition to the regular energy multiplier. In order to avoid loss of precision at high values, brightness values are premultiplied by an exposure normalization value. In support of Physical Light Units this PR also renames CameraEffects to CameraAttributes.
2022-07-31 23:20:24 +00:00
<method name="camera_attributes_set_auto_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 13:28:05 +00:00
<return type="void" />
Implement Physical Light Units as an optional setting. This allows light sources to be specified in physical light units in addition to the regular energy multiplier. In order to avoid loss of precision at high values, brightness values are premultiplied by an exposure normalization value. In support of Physical Light Units this PR also renames CameraEffects to CameraAttributes.
2022-07-31 23:20:24 +00:00
<param index="0" name="camera_attributes" type="RID" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="1" name="enable" type="bool" />
Implement Physical Light Units as an optional setting. This allows light sources to be specified in physical light units in addition to the regular energy multiplier. In order to avoid loss of precision at high values, brightness values are premultiplied by an exposure normalization value. In support of Physical Light Units this PR also renames CameraEffects to CameraAttributes.
2022-07-31 23:20:24 +00:00
<param index="2" name="min_sensitivity" type="float" />
<param index="3" name="max_sensitivity" type="float" />
<param index="4" name="speed" type="float" />
<param index="5" name="scale" type="float" />
classref: Sync with current source
2017-10-21 10:02:08 +00:00
<description>
</description>
</method>
Implement Physical Light Units as an optional setting. This allows light sources to be specified in physical light units in addition to the regular energy multiplier. In order to avoid loss of precision at high values, brightness values are premultiplied by an exposure normalization value. In support of Physical Light Units this PR also renames CameraEffects to CameraAttributes.
2022-07-31 23:20:24 +00:00
<method name="camera_attributes_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 13:28:05 +00:00
<return type="void" />
Implement Physical Light Units as an optional setting. This allows light sources to be specified in physical light units in addition to the regular energy multiplier. In order to avoid loss of precision at high values, brightness values are premultiplied by an exposure normalization value. In support of Physical Light Units this PR also renames CameraEffects to CameraAttributes.
2022-07-31 23:20:24 +00:00
<param index="0" name="camera_attributes" type="RID" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="1" name="far_enable" type="bool" />
<param index="2" name="far_distance" type="float" />
<param index="3" name="far_transition" type="float" />
<param index="4" name="near_enable" type="bool" />
<param index="5" name="near_distance" type="float" />
<param index="6" name="near_transition" type="float" />
<param index="7" name="amount" type="float" />
classref: Sync with current source
2017-10-21 10:02:08 +00:00
<description>
</description>
</method>
Implement Physical Light Units as an optional setting. This allows light sources to be specified in physical light units in addition to the regular energy multiplier. In order to avoid loss of precision at high values, brightness values are premultiplied by an exposure normalization value. In support of Physical Light Units this PR also renames CameraEffects to CameraAttributes.
2022-07-31 23:20:24 +00:00
<method name="camera_attributes_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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param 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 02:17:47 +00:00
<description>
</description>
</method>
Implement Physical Light Units as an optional setting. This allows light sources to be specified in physical light units in addition to the regular energy multiplier. In order to avoid loss of precision at high values, brightness values are premultiplied by an exposure normalization value. In support of Physical Light Units this PR also renames CameraEffects to CameraAttributes.
2022-07-31 23:20:24 +00:00
<method name="camera_attributes_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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="quality" type="int" enum="RenderingServer.DOFBlurQuality" />
<param 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 02:17:47 +00:00
<description>
</description>
</method>
Implement Physical Light Units as an optional setting. This allows light sources to be specified in physical light units in addition to the regular energy multiplier. In order to avoid loss of precision at high values, brightness values are premultiplied by an exposure normalization value. In support of Physical Light Units this PR also renames CameraEffects to CameraAttributes.
2022-07-31 23:20:24 +00:00
<method name="camera_attributes_set_exposure">
<return type="void" />
<param index="0" name="camera_attributes" type="RID" />
<param index="1" name="multiplier" type="float" />
<param index="2" name="normalization" type="float" />
<description>
Sets the exposure values that will be used by the renderers. The normalization amount is used to bake a given Exposure Value (EV) into rendering calculations to reduce the dynamic range of the scene.
The normalization factor can be calculated from exposure value (EV100) as follows:
[codeblock]
func get_exposure_normalization(float ev100):
return 1.0 / (pow(2.0, ev100) * 1.2)
[/codeblock]
The exposure value can be calculated from aperture (in f-stops), shutter speed (in seconds), and sensitivity (in ISO) as follows:
[codeblock]
func get_exposure(float aperture, float shutter_speed, float sensitivity):
return log2((aperture * aperture) / shutterSpeed * (100.0 / sensitivity))
[/codeblock]
</description>
</method>
<method name="camera_create">
<return type="RID" />
<description>
Creates a camera and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all [code]camera_*[/code] RenderingServer functions.
Once finished with your RID, you will want to free the RID using the RenderingServer's [method free_rid] static method.
</description>
</method>
<method name="camera_set_camera_attributes">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="camera" type="RID" />
<param index="1" name="effects" type="RID" />
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="camera" type="RID" />
<param index="1" name="layers" type="int" />
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 16:22:57 +00: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 09:47:16 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="camera" type="RID" />
<param index="1" name="env" type="RID" />
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 16:22:57 +00:00
Sets the environment used by this camera. Equivalent to [member Camera3D.environment].
doc: Sync classref with current source
2018-02-19 09:47:16 +00:00
</description>
</method>
Added inspector plugin documentation. Fixed plugin bindings.
2019-04-23 19:39:09 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="camera" type="RID" />
<param index="1" name="size" type="float" />
<param index="2" name="offset" type="Vector2" />
<param index="3" name="z_near" type="float" />
<param index="4" name="z_far" type="float" />
Added inspector plugin documentation. Fixed plugin bindings.
2019-04-23 19:39:09 +00:00
<description>
[doc] Use "param" instead of "code" to refer to parameters (4)
2022-08-11 17:52:19 +00:00
Sets camera to use frustum projection. This mode allows adjusting the [param offset] argument to create "tilted frustum" effects.
Added inspector plugin documentation. Fixed plugin bindings.
2019-04-23 19:39:09 +00:00
</description>
</method>
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="camera" type="RID" />
<param index="1" name="size" type="float" />
<param index="2" name="z_near" type="float" />
<param index="3" name="z_far" type="float" />
doc: Sync classref with current source
2018-02-19 09:47:16 +00:00
<description>
Updated docs for many VisualServer methods
2019-12-15 00:38:19 +00: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 09:47:16 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="camera" type="RID" />
<param index="1" name="fovy_degrees" type="float" />
<param index="2" name="z_near" type="float" />
<param index="3" name="z_far" type="float" />
doc: Sync classref with current source
2018-02-19 09:47:16 +00:00
<description>
Updated docs for many VisualServer methods
2019-12-15 00:38:19 +00: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 09:47:16 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="camera" type="RID" />
<param index="1" name="transform" type="Transform3D" />
doc: Sync classref with current source
2018-02-19 09:47:16 +00:00
<description>
Update documentation for Transform3D
2020-05-03 08:27:36 +00:00
Sets [Transform3D] of camera.
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="camera" type="RID" />
<param index="1" name="enable" type="bool" />
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 16:22:57 +00: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 09:47:16 +00:00
</description>
</method>
classref: Sync with current source
2017-10-21 10:02:08 +00: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 13:28:05 +00:00
<return type="RID" />
classref: Sync with current source
2017-10-21 10:02:08 +00: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 16:22:57 +00: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 10:02:08 +00:00
</description>
</method>
Expose `RenderingServer::canvas_item_add_animation_slice` in GDScript
2022-03-13 13:25:20 +00:00
<method name="canvas_item_add_animation_slice">
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="item" type="RID" />
<param index="1" name="animation_length" type="float" />
<param index="2" name="slice_begin" type="float" />
<param index="3" name="slice_end" type="float" />
<param index="4" name="offset" type="float" default="0.0" />
Expose `RenderingServer::canvas_item_add_animation_slice` in GDScript
2022-03-13 13:25:20 +00:00
<description>
Subsequent drawing commands will be ignored unless they fall within the specified animation slice. This is a faster way to implement animations that loop on background rather than redrawing constantly.
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="item" type="RID" />
<param index="1" name="pos" type="Vector2" />
<param index="2" name="radius" type="float" />
<param index="3" name="color" type="Color" />
classref: Sync with current source
2017-10-21 10:02:08 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="item" type="RID" />
<param index="1" name="ignore" type="bool" />
classref: Sync with current source
2017-10-21 10:02:08 +00:00
<description>
</description>
</method>
Add font LCD sub-pixel anti-aliasing support.
2022-08-12 11:03:28 +00:00
<method name="canvas_item_add_lcd_texture_rect_region">
<return type="void" />
<param index="0" name="item" type="RID" />
<param index="1" name="rect" type="Rect2" />
<param index="2" name="texture" type="RID" />
<param index="3" name="src_rect" type="Rect2" />
<param index="4" name="modulate" type="Color" />
<description>
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="item" type="RID" />
<param index="1" name="from" type="Vector2" />
<param index="2" name="to" type="Vector2" />
<param index="3" name="color" type="Color" />
Fix scaling issue in `draw_line` and similar methods
2023-01-14 05:28:55 +00:00
<param index="4" name="width" type="float" default="-1.0" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="5" name="antialiased" type="bool" default="false" />
classref: Sync with current source
2017-10-21 10:02:08 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="item" type="RID" />
<param index="1" name="mesh" type="RID" />
<param index="2" name="transform" type="Transform2D" default="Transform2D(1, 0, 0, 1, 0, 0)" />
<param index="3" name="modulate" type="Color" default="Color(1, 1, 1, 1)" />
<param index="4" name="texture" type="RID" />
classref: Sync with current source
2017-10-21 10:02:08 +00:00
<description>
</description>
</method>
Implement TextServer GDExtension interface, remove TextServer GDNative interface.
2021-08-27 21:19:51 +00:00
<method name="canvas_item_add_msdf_texture_rect_region">
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="item" type="RID" />
<param index="1" name="rect" type="Rect2" />
<param index="2" name="texture" type="RID" />
<param index="3" name="src_rect" type="Rect2" />
<param index="4" name="modulate" type="Color" default="Color(1, 1, 1, 1)" />
<param index="5" name="outline_size" type="int" default="0" />
<param index="6" name="px_range" type="float" default="1.0" />
Scale MSDF font outline with the font size and MSDF source size to match dynamic font behavior.
2022-12-17 20:47:33 +00:00
<param index="7" name="scale" type="float" default="1.0" />
Implement TextServer GDExtension interface, remove TextServer GDNative interface.
2021-08-27 21:19:51 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="item" type="RID" />
<param index="1" name="mesh" type="RID" />
<param index="2" name="texture" type="RID" />
classref: Sync with current source
2017-10-21 10:02:08 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="item" type="RID" />
<param index="1" name="rect" type="Rect2" />
<param index="2" name="source" type="Rect2" />
<param index="3" name="texture" type="RID" />
<param index="4" name="topleft" type="Vector2" />
<param index="5" name="bottomright" type="Vector2" />
<param index="6" name="x_axis_mode" type="int" enum="RenderingServer.NinePatchAxisMode" default="0" />
<param index="7" name="y_axis_mode" type="int" enum="RenderingServer.NinePatchAxisMode" default="0" />
<param index="8" name="draw_center" type="bool" default="true" />
<param index="9" name="modulate" type="Color" default="Color(1, 1, 1, 1)" />
classref: Sync with current source
2017-10-21 10:02:08 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="item" type="RID" />
<param index="1" name="particles" type="RID" />
<param index="2" name="texture" type="RID" />
classref: Sync with current source
2017-10-21 10:02:08 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="item" type="RID" />
<param index="1" name="points" type="PackedVector2Array" />
<param index="2" name="colors" type="PackedColorArray" />
<param index="3" name="uvs" type="PackedVector2Array" default="PackedVector2Array()" />
<param index="4" name="texture" type="RID" />
classref: Sync with current source
2017-10-21 10:02:08 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="item" type="RID" />
<param index="1" name="points" type="PackedVector2Array" />
<param index="2" name="colors" type="PackedColorArray" />
CanvasItem::draw_polyline Support thin polylines drawn using line strip
2023-01-19 12:38:15 +00:00
<param index="3" name="width" type="float" default="-1.0" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="4" name="antialiased" type="bool" default="false" />
classref: Sync with current source
2017-10-21 10:02:08 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="item" type="RID" />
<param index="1" name="points" type="PackedVector2Array" />
<param index="2" name="colors" type="PackedColorArray" />
<param index="3" name="uvs" type="PackedVector2Array" />
<param index="4" name="texture" type="RID" />
classref: Sync with current source
2017-10-21 10:02:08 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="item" type="RID" />
<param index="1" name="rect" type="Rect2" />
<param index="2" name="color" type="Color" />
classref: Sync with current source
2017-10-21 10:02:08 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="item" type="RID" />
<param index="1" name="transform" type="Transform2D" />
classref: Sync with current source
2017-10-21 10:02:08 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="item" type="RID" />
<param index="1" name="rect" type="Rect2" />
<param index="2" name="texture" type="RID" />
<param index="3" name="tile" type="bool" default="false" />
<param index="4" name="modulate" type="Color" default="Color(1, 1, 1, 1)" />
<param index="5" name="transpose" type="bool" default="false" />
classref: Sync with current source
2017-10-21 10:02:08 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="item" type="RID" />
<param index="1" name="rect" type="Rect2" />
<param index="2" name="texture" type="RID" />
<param index="3" name="src_rect" type="Rect2" />
<param index="4" name="modulate" type="Color" default="Color(1, 1, 1, 1)" />
<param index="5" name="transpose" type="bool" default="false" />
<param index="6" name="clip_uv" type="bool" default="true" />
classref: Sync with current source
2017-10-21 10:02:08 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="item" type="RID" />
<param index="1" name="indices" type="PackedInt32Array" />
<param index="2" name="points" type="PackedVector2Array" />
<param index="3" name="colors" type="PackedColorArray" />
<param index="4" name="uvs" type="PackedVector2Array" default="PackedVector2Array()" />
<param index="5" name="bones" type="PackedInt32Array" default="PackedInt32Array()" />
<param index="6" name="weights" type="PackedFloat32Array" default="PackedFloat32Array()" />
<param index="7" name="texture" type="RID" />
<param index="8" name="count" type="int" default="-1" />
classref: Sync with current source
2017-10-21 10:02:08 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="item" type="RID" />
classref: Sync with current source
2017-10-21 10:02:08 +00: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 02:17:47 +00:00
Clears the [CanvasItem] and removes all commands in it.
classref: Sync with current source
2017-10-21 10:02:08 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="RID" />
classref: Sync with current source
2017-10-21 10:02:08 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="item" type="RID" />
<param index="1" name="mode" type="int" enum="RenderingServer.CanvasGroupMode" />
<param index="2" name="clear_margin" type="float" default="5.0" />
<param index="3" name="fit_empty" type="bool" default="false" />
<param index="4" name="fit_margin" type="float" default="0.0" />
<param index="5" name="blur_mipmaps" type="bool" default="false" />
classref: Sync with current source
2017-10-21 10:02:08 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="item" type="RID" />
<param index="1" name="clip" type="bool" />
classref: Sync with current source
2017-10-21 10:02:08 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="item" type="RID" />
<param index="1" name="enabled" type="bool" />
<param index="2" name="rect" type="Rect2" />
classref: Sync with current source
2017-10-21 10:02:08 +00: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 02:17:47 +00:00
Sets the [CanvasItem] to copy a rect to the backbuffer.
classref: Sync with current source
2017-10-21 10:02:08 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="item" type="RID" />
<param index="1" name="use_custom_rect" type="bool" />
<param index="2" name="rect" type="Rect2" default="Rect2(0, 0, 0, 0)" />
classref: Sync with current source
2017-10-21 10:02:08 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="item" type="RID" />
<param index="1" name="filter" type="int" enum="RenderingServer.CanvasItemTextureFilter" />
classref: Sync with current source
2017-10-21 10:02:08 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="item" type="RID" />
<param index="1" name="repeat" type="int" enum="RenderingServer.CanvasItemTextureRepeat" />
classref: Sync with current source
2017-10-21 10:02:08 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="item" type="RID" />
<param index="1" name="enabled" type="bool" />
classref: Sync with current source
2017-10-21 10:02:08 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="item" type="RID" />
<param index="1" name="enabled" type="bool" />
classref: Sync with current source
2017-10-21 10:02:08 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="item" type="RID" />
<param index="1" name="index" type="int" />
classref: Sync with current source
2017-10-21 10:02:08 +00: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 02:17:47 +00:00
Sets the index for the [CanvasItem].
classref: Sync with current source
2017-10-21 10:02:08 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="item" type="RID" />
<param index="1" name="mask" type="int" />
classref: Sync with current source
2017-10-21 10:02:08 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="item" type="RID" />
<param index="1" name="material" type="RID" />
classref: Sync with current source
2017-10-21 10:02:08 +00: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 02:17:47 +00: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 14:38:26 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="item" type="RID" />
<param 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 14:38:26 +00:00
<description>
classref: Sync with current source
2017-10-21 10:02:08 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="item" type="RID" />
<param index="1" name="parent" type="RID" />
classref: Sync with current source
2017-10-21 10:02:08 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="item" type="RID" />
<param 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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="item" type="RID" />
<param index="1" name="enabled" type="bool" />
classref: Sync with current source
2017-10-21 10:02:08 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="item" type="RID" />
<param index="1" name="transform" type="Transform2D" />
classref: Sync with current source
2017-10-21 10:02:08 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="item" type="RID" />
<param index="1" name="enabled" type="bool" />
classref: Sync with current source
2017-10-21 10:02:08 +00: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 02:17:47 +00:00
Sets if the [CanvasItem] uses its parent's material.
classref: Sync with current source
2017-10-21 10:02:08 +00:00
</description>
</method>
Viewport canvas cull mask feature Co-authored-by: Valentin Zagura <puthre@gmail.com>
2021-09-02 18:07:04 +00:00
<method name="canvas_item_set_visibility_layer">
<return type="void" />
<param index="0" name="item" type="RID" />
<param index="1" name="visibility_layer" type="int" />
<description>
Sets the rendering visibility layer associated with this [CanvasItem]. Only [Viewport] nodes with a matching rendering mask will render this [CanvasItem].
</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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="item" type="RID" />
<param index="1" name="enable" type="bool" />
<param index="2" name="area" type="Rect2" />
<param index="3" name="enter_callable" type="Callable" />
<param index="4" name="exit_callable" type="Callable" />
classref: Sync with current source
2017-10-21 10:02:08 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="item" type="RID" />
<param 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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="item" type="RID" />
<param index="1" name="enabled" type="bool" />
classref: Sync with current source
2017-10-21 10:02:08 +00: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 02:17:47 +00: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 10:02:08 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="item" type="RID" />
<param index="1" name="z_index" type="int" />
classref: Sync with current source
2017-10-21 10:02:08 +00: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 02:17:47 +00: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 10:02:08 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="light" type="RID" />
<param index="1" name="canvas" type="RID" />
doc: Sync classref with current source
2020-10-09 13:04:15 +00: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 02:17:47 +00:00
Attaches the canvas light to the canvas. Removes it from its previous canvas.
doc: Sync classref with current source
2020-10-09 13:04:15 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="RID" />
classref: Sync with current source
2017-10-21 10:02:08 +00: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 02:17:47 +00: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 16:22:57 +00: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 10:02:08 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="occluder" type="RID" />
<param 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 02:17:47 +00: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 13:28:05 +00:00
<return type="RID" />
classref: Sync with current source
2017-10-21 10:02:08 +00: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 02:17:47 +00: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 16:22:57 +00: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 10:02:08 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="occluder" type="RID" />
<param index="1" name="enable" type="bool" />
classref: Sync with current source
2017-10-21 10:02:08 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="occluder" type="RID" />
<param index="1" name="enabled" type="bool" />
classref: Sync with current source
2017-10-21 10:02:08 +00: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 02:17:47 +00:00
Enables or disables light occluder.
classref: Sync with current source
2017-10-21 10:02:08 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="occluder" type="RID" />
<param index="1" name="mask" type="int" />
classref: Sync with current source
2017-10-21 10:02:08 +00: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 02:17:47 +00:00
The light mask. See [LightOccluder2D] for more information on light masks.
classref: Sync with current source
2017-10-21 10:02:08 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="occluder" type="RID" />
<param index="1" name="polygon" type="RID" />
classref: Sync with current source
2017-10-21 10:02:08 +00: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 02:17:47 +00:00
Sets a light occluder's polygon.
classref: Sync with current source
2017-10-21 10:02:08 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="occluder" type="RID" />
<param index="1" name="transform" type="Transform2D" />
classref: Sync with current source
2017-10-21 10:02:08 +00: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 02:17:47 +00:00
Sets a light occluder's [Transform2D].
classref: Sync with current source
2017-10-21 10:02:08 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="light" type="RID" />
<param index="1" name="color" type="Color" />
classref: Sync with current source
2017-10-21 10:02:08 +00: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 02:17:47 +00:00
Sets the color for a light.
classref: Sync with current source
2017-10-21 10:02:08 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="light" type="RID" />
<param index="1" name="enabled" type="bool" />
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 02:17:47 +00:00
Enables or disables a canvas light.
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="light" type="RID" />
<param index="1" name="energy" type="float" />
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 02:17:47 +00:00
Sets a canvas light's energy.
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="light" type="RID" />
<param index="1" name="height" type="float" />
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 02:17:47 +00:00
Sets a canvas light's height.
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="light" type="RID" />
<param index="1" name="mask" type="int" />
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 02:17:47 +00:00
The light mask. See [LightOccluder2D] for more information on light masks.
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="light" type="RID" />
<param index="1" name="mask" type="int" />
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 02:17:47 +00: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 09:47:16 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="light" type="RID" />
<param index="1" name="min_layer" type="int" />
<param index="2" name="max_layer" type="int" />
Fix VisualServer bindings.
2020-02-16 17:55:40 +00: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 02:17:47 +00:00
The layer range that gets rendered with this light.
Fix VisualServer bindings.
2020-02-16 17:55:40 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="light" type="RID" />
<param index="1" name="mode" type="int" enum="RenderingServer.CanvasLightMode" />
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 02:17:47 +00:00
The mode of the light, see [enum CanvasLightMode] constants.
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="light" type="RID" />
<param 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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="light" type="RID" />
<param index="1" name="enabled" type="bool" />
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 02:17:47 +00:00
Enables or disables the canvas light's shadow.
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="light" type="RID" />
<param index="1" name="filter" type="int" enum="RenderingServer.CanvasLightShadowFilter" />
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 02:17:47 +00:00
Sets the canvas light's shadow's filter, see [enum CanvasLightShadowFilter] constants.
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="light" type="RID" />
<param index="1" name="smooth" type="float" />
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 02:17:47 +00:00
Smoothens the shadow. The lower, the smoother.
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="light" type="RID" />
<param index="1" name="texture" type="RID" />
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 02:17:47 +00:00
Sets the texture to be used by a [PointLight2D]. Equivalent to [member PointLight2D.texture].
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="light" type="RID" />
<param index="1" name="offset" type="Vector2" />
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 02:17:47 +00:00
Sets the offset of a [PointLight2D]'s texture. Equivalent to [member PointLight2D.offset].
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="light" type="RID" />
<param index="1" name="scale" type="float" />
doc: Sync classref with current source
2021-01-04 13:33:44 +00: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 02:17:47 +00: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 13:33:44 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="light" type="RID" />
<param index="1" name="transform" type="Transform2D" />
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 02:17:47 +00:00
Sets the canvas light's [Transform2D].
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="light" type="RID" />
<param index="1" name="min_z" type="int" />
<param index="2" name="max_z" type="int" />
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 02:17:47 +00: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 09:47:16 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="RID" />
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 02:17:47 +00: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 09:47:16 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="occluder_polygon" type="RID" />
<param index="1" name="mode" type="int" enum="RenderingServer.CanvasOccluderPolygonCullMode" />
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 02:17:47 +00:00
Sets an occluder polygons cull mode. See [enum CanvasOccluderPolygonCullMode] constants.
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="occluder_polygon" type="RID" />
<param index="1" name="shape" type="PackedVector2Array" />
<param index="2" name="closed" type="bool" />
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 02:17:47 +00:00
Sets the shape of the occluder polygon.
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="disable" type="bool" />
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="canvas" type="RID" />
<param index="1" name="item" type="RID" />
<param index="2" name="mirroring" type="Vector2" />
doc: Sync classref with current source Add missing enum bindings.
2020-04-20 09:48:00 +00: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 02:17:47 +00: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 09:48:00 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="canvas" type="RID" />
<param index="1" name="color" type="Color" />
doc: Sync classref with current source Add missing enum bindings.
2020-04-20 09:48:00 +00: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 02:17:47 +00:00
Modulates all colors in the given canvas.
doc: Sync classref with current source Add missing enum bindings.
2020-04-20 09:48:00 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="size" type="int" />
doc: Sync classref with current source Add missing enum bindings.
2020-04-20 09:48:00 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="RID" />
doc: Sync classref with current source Add missing enum bindings.
2020-04-20 09:48:00 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="canvas_texture" type="RID" />
<param index="1" name="channel" type="int" enum="RenderingServer.CanvasTextureChannel" />
<param index="2" name="texture" type="RID" />
doc: Sync classref with current source Add missing enum bindings.
2020-04-20 09:48:00 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="canvas_texture" type="RID" />
<param index="1" name="base_color" type="Color" />
<param index="2" name="shininess" type="float" />
doc: Sync classref with current source Add missing enum bindings.
2020-04-20 09:48:00 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="canvas_texture" type="RID" />
<param index="1" name="filter" type="int" enum="RenderingServer.CanvasItemTextureFilter" />
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="canvas_texture" type="RID" />
<param index="1" name="repeat" type="int" enum="RenderingServer.CanvasItemTextureRepeat" />
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="RenderingDevice" />
doc: Sync classref with current source
2018-02-19 09:47:16 +00:00
<description>
RenderingServer::create_local_rendering_device null check and docs Co-authored-by: Clay John <claynjohn@gmail.com>
2022-11-19 11:22:27 +00:00
Creates a RenderingDevice that can be used to do draw and compute operations on a separate thread. Cannot draw to the screen nor share data with the global RenderingDevice.
[b]Note:[/b] When using the OpenGL backend or when running in headless mode, this function always returns [code]null[/code].
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="RID" />
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="decal" type="RID" />
<param index="1" name="albedo_mix" type="float" />
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="decal" type="RID" />
<param index="1" name="mask" type="int" />
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="decal" type="RID" />
<param index="1" name="enabled" type="bool" />
<param index="2" name="begin" type="float" />
<param index="3" name="length" type="float" />
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="decal" type="RID" />
<param index="1" name="energy" type="float" />
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="decal" type="RID" />
<param index="1" name="extents" type="Vector3" />
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="decal" type="RID" />
<param index="1" name="above" type="float" />
<param index="2" name="below" type="float" />
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="decal" type="RID" />
<param 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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="decal" type="RID" />
<param 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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="decal" type="RID" />
<param index="1" name="type" type="int" enum="RenderingServer.DecalTexture" />
<param 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 02:17:47 +00: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 19:41:55 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param 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 19:41:55 +00: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 02:17:47 +00: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 13:28:05 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="size" type="int" />
<param 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 02:17:47 +00:00
<description>
</description>
</method>
Rename soft shadow quality project settings for easier searching `rendering/quality/shadows` is now `rendering/quality/positional_shadow` to explicitly denote that the settings only affect positional light shadows, not directional light shadows. Shadow atlas settings now contain the word "atlas" for easier searching. Soft shadow quality settings were renamed to contain the word "filter". This makes the settings appear when searching for "filter" in the project settings dialog, like in Godot 3.x.
2022-04-30 23:40:30 +00:00
<method name="directional_soft_shadow_filter_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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param 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 02:17:47 +00: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 13:28:05 +00:00
<return type="Image" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="environment" type="RID" />
<param index="1" name="bake_irradiance" type="bool" />
<param 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 02:17:47 +00: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 13:28:05 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param 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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="env" type="RID" />
<param index="1" name="enable" type="bool" />
<param index="2" name="brightness" type="float" />
<param index="3" name="contrast" type="float" />
<param index="4" name="saturation" type="float" />
<param index="5" name="use_1d_color_correction" type="bool" />
<param index="6" name="color_correction" type="RID" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="env" type="RID" />
<param index="1" name="color" type="Color" />
<param index="2" name="ambient" type="int" enum="RenderingServer.EnvironmentAmbientSource" default="0" />
<param index="3" name="energy" type="float" default="1.0" />
<param index="4" name="sky_contibution" type="float" default="0.0" />
<param index="5" name="reflection_source" type="int" enum="RenderingServer.EnvironmentReflectionSource" default="0" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="env" type="RID" />
<param 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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="env" type="RID" />
<param 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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="env" type="RID" />
Implement Physical Light Units as an optional setting. This allows light sources to be specified in physical light units in addition to the regular energy multiplier. In order to avoid loss of precision at high values, brightness values are premultiplied by an exposure normalization value. In support of Physical Light Units this PR also renames CameraEffects to CameraAttributes.
2022-07-31 23:20:24 +00:00
<param index="1" name="multiplier" type="float" />
<param index="2" name="exposure_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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="env" type="RID" />
<param 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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="env" type="RID" />
<param index="1" name="enable" type="bool" />
<param index="2" name="light_color" type="Color" />
<param index="3" name="light_energy" type="float" />
<param index="4" name="sun_scatter" type="float" />
<param index="5" name="density" type="float" />
<param index="6" name="height" type="float" />
<param index="7" name="height_density" type="float" />
<param index="8" name="aerial_perspective" type="float" />
Add Environment properties to control fog rendering on background sky Values lower than 1.0 can be used to make the fog rendering not fully obstruct the sky. This can be desired when using fog as a purely atmospheric effect, without intending to use fog for open world fog fading. When set to 0.0, fog rendering behavior will be similar to Godot 3.x where sky rendering was never affected by fog.
2022-02-23 22:54:06 +00:00
<param index="9" name="sky_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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="env" type="RID" />
<param index="1" name="enable" type="bool" />
<param index="2" name="levels" type="PackedFloat32Array" />
<param index="3" name="intensity" type="float" />
<param index="4" name="strength" type="float" />
<param index="5" name="mix" type="float" />
<param index="6" name="bloom_threshold" type="float" />
<param index="7" name="blend_mode" type="int" enum="RenderingServer.EnvironmentGlowBlendMode" />
<param index="8" name="hdr_bleed_threshold" type="float" />
<param index="9" name="hdr_bleed_scale" type="float" />
<param index="10" name="hdr_luminance_cap" type="float" />
<param index="11" name="glow_map_strength" type="float" />
<param index="12" name="glow_map" type="RID" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="env" type="RID" />
<param index="1" name="enable" type="bool" />
<param index="2" name="cascades" type="int" />
<param index="3" name="min_cell_size" type="float" />
<param index="4" name="y_scale" type="int" enum="RenderingServer.EnvironmentSDFGIYScale" />
<param index="5" name="use_occlusion" type="bool" />
<param index="6" name="bounce_feedback" type="float" />
<param index="7" name="read_sky" type="bool" />
<param index="8" name="energy" type="float" />
<param index="9" name="normal_bias" type="float" />
<param index="10" name="probe_bias" type="float" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param 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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param 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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param 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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="env" type="RID" />
<param 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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="env" type="RID" />
<param 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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="env" type="RID" />
<param 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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="env" type="RID" />
<param index="1" name="enable" type="bool" />
<param index="2" name="radius" type="float" />
<param index="3" name="intensity" type="float" />
<param index="4" name="power" type="float" />
<param index="5" name="detail" type="float" />
<param index="6" name="horizon" type="float" />
<param index="7" name="sharpness" type="float" />
<param index="8" name="light_affect" type="float" />
<param index="9" name="ao_channel_affect" type="float" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 02:17:47 +00:00
<description>
Expose RenderingServer SSIL quality setter methods This allows changing SSIL quality at run-time in a project.
2022-01-06 01:35:49 +00:00
Sets the variables to be used with the screen-space ambient occlusion (SSAO) post-process effect. See [Environment] for more details.
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 02:17:47 +00:00
</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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="quality" type="int" enum="RenderingServer.EnvironmentSSAOQuality" />
<param index="1" name="half_size" type="bool" />
<param index="2" name="adaptive_target" type="float" />
<param index="3" name="blur_passes" type="int" />
<param index="4" name="fadeout_from" type="float" />
<param index="5" name="fadeout_to" type="float" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 02:17:47 +00:00
<description>
Expose RenderingServer SSIL quality setter methods This allows changing SSIL quality at run-time in a project.
2022-01-06 01:35:49 +00:00
Sets the quality level of the screen-space ambient occlusion (SSAO) post-process effect. See [Environment] for more details.
</description>
</method>
<method name="environment_set_ssil_quality">
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="quality" type="int" enum="RenderingServer.EnvironmentSSILQuality" />
<param index="1" name="half_size" type="bool" />
<param index="2" name="adaptive_target" type="float" />
<param index="3" name="blur_passes" type="int" />
<param index="4" name="fadeout_from" type="float" />
<param index="5" name="fadeout_to" type="float" />
Expose RenderingServer SSIL quality setter methods This allows changing SSIL quality at run-time in a project.
2022-01-06 01:35:49 +00:00
<description>
Sets the quality level of the screen-space indirect lighting (SSIL) post-process effect. See [Environment] for more details.
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 02:17:47 +00:00
</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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="env" type="RID" />
<param index="1" name="enable" type="bool" />
<param index="2" name="max_steps" type="int" />
<param index="3" name="fade_in" type="float" />
<param index="4" name="fade_out" type="float" />
<param index="5" name="depth_tolerance" type="float" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param 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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="env" type="RID" />
<param index="1" name="tone_mapper" type="int" enum="RenderingServer.EnvironmentToneMapper" />
<param index="2" name="exposure" type="float" />
<param index="3" name="white" type="float" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="env" type="RID" />
<param index="1" name="enable" type="bool" />
<param index="2" name="density" type="float" />
<param index="3" name="albedo" type="Color" />
<param index="4" name="emission" type="Color" />
<param index="5" name="emission_energy" type="float" />
<param index="6" name="anisotropy" type="float" />
<param index="7" name="length" type="float" />
<param index="8" name="p_detail_spread" type="float" />
<param index="9" name="gi_inject" type="float" />
<param index="10" name="temporal_reprojection" type="bool" />
<param index="11" name="temporal_reprojection_amount" type="float" />
<param index="12" name="ambient_inject" type="float" />
Add Environment properties to control fog rendering on background sky Values lower than 1.0 can be used to make the fog rendering not fully obstruct the sky. This can be desired when using fog as a purely atmospheric effect, without intending to use fog for open world fog fading. When set to 0.0, fog rendering behavior will be similar to Godot 3.x where sky rendering was never affected by fog.
2022-02-23 22:54:06 +00:00
<param index="13" name="sky_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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param 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 02:17:47 +00:00
<description>
Addition of FogVolumes, FogShaders, FogMaterial, and overhaul of VolumetricFog Co-authored-by: Brian Semrau <brian.semrau@gmail.com>
2021-10-03 11:28:55 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="size" type="int" />
<param 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 02:17:47 +00:00
<description>
[doc] Use "param" instead of "code" to refer to parameters (4)
2022-08-11 17:52:19 +00:00
Sets the resolution of the volumetric fog's froxel buffer. [param size] is modified by the screen's aspect ratio and then used to set the width and height of the buffer. While [param depth] is directly used to set the depth of the buffer.
Addition of FogVolumes, FogShaders, FogMaterial, and overhaul of VolumetricFog Co-authored-by: Brian Semrau <brian.semrau@gmail.com>
2021-10-03 11:28:55 +00:00
</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" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="fog_volume" type="RID" />
<param index="1" name="extents" type="Vector3" />
Addition of FogVolumes, FogShaders, FogMaterial, and overhaul of VolumetricFog Co-authored-by: Brian Semrau <brian.semrau@gmail.com>
2021-10-03 11:28:55 +00:00
<description>
Add Cone and Cylinder shapes to FogVolume This complements the existing Ellipsoid and Box local fog shapes. This can be used to represent a light cone coming from a SpotLight.
2022-05-21 10:17:49 +00:00
Sets the size of the fog volume when shape is [constant RenderingServer.FOG_VOLUME_SHAPE_ELLIPSOID], [constant RenderingServer.FOG_VOLUME_SHAPE_CONE], [constant RenderingServer.FOG_VOLUME_SHAPE_CYLINDER] or [constant RenderingServer.FOG_VOLUME_SHAPE_BOX].
Addition of FogVolumes, FogShaders, FogMaterial, and overhaul of VolumetricFog Co-authored-by: Brian Semrau <brian.semrau@gmail.com>
2021-10-03 11:28:55 +00:00
</description>
</method>
<method name="fog_volume_set_material">
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="fog_volume" type="RID" />
<param index="1" name="material" type="RID" />
Addition of FogVolumes, FogShaders, FogMaterial, and overhaul of VolumetricFog Co-authored-by: Brian Semrau <brian.semrau@gmail.com>
2021-10-03 11:28:55 +00:00
<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" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="fog_volume" type="RID" />
<param index="1" name="shape" type="int" enum="RenderingServer.FogVolumeShape" />
Addition of FogVolumes, FogShaders, FogMaterial, and overhaul of VolumetricFog Co-authored-by: Brian Semrau <brian.semrau@gmail.com>
2021-10-03 11:28:55 +00:00
<description>
Add Cone and Cylinder shapes to FogVolume This complements the existing Ellipsoid and Box local fog shapes. This can be used to represent a light cone coming from a SpotLight.
2022-05-21 10:17:49 +00:00
Sets the shape of the fog volume to either [constant RenderingServer.FOG_VOLUME_SHAPE_ELLIPSOID], [constant RenderingServer.FOG_VOLUME_SHAPE_CONE], [constant RenderingServer.FOG_VOLUME_SHAPE_CYLINDER], [constant RenderingServer.FOG_VOLUME_SHAPE_BOX] or [constant RenderingServer.FOG_VOLUME_SHAPE_WORLD].
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="swap_buffers" type="bool" default="true" />
<param 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 02:17:47 +00: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 13:28:05 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param 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 02:17:47 +00:00
<description>
Tries to free an object in the RenderingServer.
</description>
</method>
Add framework for avoidance of color flash in new windows
2023-01-11 18:14:43 +00:00
<method name="get_default_clear_color">
<return type="Color" />
<description>
Returns the default clear color which is used when a specific clear color has not been selected.
</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 02:17:47 +00:00
<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 13:28:05 +00: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 02:17:47 +00:00
<description>
</description>
</method>
Expose Vulkan internal values for access from extensions
2021-08-29 02:52:19 +00:00
<method name="get_rendering_device" qualifiers="const">
<return type="RenderingDevice" />
<description>
RenderingServer::create_local_rendering_device null check and docs Co-authored-by: Clay John <claynjohn@gmail.com>
2022-11-19 11:22:27 +00:00
Returns the global RenderingDevice.
[b]Note:[/b] When using the OpenGL backend or when running in headless mode, this function always returns [code]null[/code].
Expose Vulkan internal values for access from extensions
2021-08-29 02:52:19 +00:00
</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-02 23:14:19 +00: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 13:28:05 +00:00
<return type="int" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param 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 02:17:47 +00:00
<description>
</description>
</method>
Rename `uniform` to `parameter` across the engine
2022-08-27 09:22:43 +00:00
<method name="get_shader_parameter_list" qualifiers="const">
<return type="Dictionary[]" />
<param index="0" name="shader" type="RID" />
<description>
Returns the parameters of a shader.
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 02:17:47 +00:00
<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 13:28:05 +00: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 02:17:47 +00:00
<description>
Use capitalized ID in the doc
2022-12-08 01:40:49 +00:00
Returns the ID of the test cube. Creates one if none exists.
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 02:17:47 +00:00
</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 13:28:05 +00: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 02:17:47 +00:00
<description>
Use capitalized ID in the doc
2022-12-08 01:40:49 +00:00
Returns the ID of the test texture. Creates one if none exists.
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 02:17:47 +00:00
</description>
</method>
Add `get_video_adapter_api_version()` to RenderingServer This method can be used to get the graphics API version currently in use (such as Vulkan). It can be used by projects for troubleshooting or statistical purposes.
2021-07-31 13:39:46 +00:00
<method name="get_video_adapter_api_version" qualifiers="const">
<return type="String" />
<description>
Returns the version of the graphics video adapter [i]currently in use[/i] (e.g. "1.2.189" for Vulkan, "3.3.0 NVIDIA 510.60.02" for OpenGL). This version may be different from the actual latest version supported by the hardware, as Godot may not always request the latest version.
[b]Note:[/b] When running a headless or server binary, this function returns an empty string.
</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 02:17:47 +00:00
<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 13:28:05 +00: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 02:17:47 +00: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>
Add `RenderingServer.get_video_adapter_type()` method This can be used to distinguish between integrated, dedicated, virtual and software-emulated GPUs. This in turn can be used to automatically adjust graphics settings, or warn users about features that may run slowly on their hardware.
2021-12-10 16:01:51 +00:00
<method name="get_video_adapter_type" qualifiers="const">
<return type="int" enum="RenderingDevice.DeviceType" />
<description>
Returns the type of the video adapter. Since dedicated graphics cards from a given generation will [i]usually[/i] be significantly faster than integrated graphics made in the same generation, the device type can be used as a basis for automatic graphics settings adjustment. However, this is not always true, so make sure to provide users with a way to manually override graphics settings.
[b]Note:[/b] When using the OpenGL backend or when running in headless mode, this function always returns [constant RenderingDevice.DEVICE_TYPE_OTHER].
</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 02:17:47 +00:00
<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 13:28:05 +00: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 02:17:47 +00: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 13:28:05 +00: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 02:17:47 +00:00
<description>
Use capitalized ID in the doc
2022-12-08 01:40:49 +00:00
Returns the ID of a white texture. Creates one if none exists.
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 02:17:47 +00:00
</description>
</method>
Expose RenderingServer GI half resolution setter method This is required for projects to be able to change the GI half-resolution setting at run-time.
2021-12-22 18:38:48 +00:00
<method name="gi_set_use_half_resolution">
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="half_resolution" type="bool" />
Expose RenderingServer GI half resolution setter method This is required for projects to be able to change the GI half-resolution setting at run-time.
2021-12-22 18:38:48 +00:00
<description>
[doc] Use "param" instead of "code" to refer to parameters (4)
2022-08-11 17:52:19 +00:00
If [param half_resolution] is [code]true[/code], renders [VoxelGI] and SDFGI ([member Environment.sdfgi_enabled]) buffers at halved resolution (e.g. 960×540 when the viewport size is 1920×1080). This improves performance significantly when VoxelGI or SDFGI is enabled, at the cost of artifacts that may be visible on polygon edges. The loss in quality becomes less noticeable as the viewport resolution increases. [LightmapGI] rendering is not affected by this setting. See also [member ProjectSettings.rendering/global_illumination/gi/use_half_resolution].
Expose RenderingServer GI half resolution setter method This is required for projects to be able to change the GI half-resolution setting at run-time.
2021-12-22 18:38:48 +00:00
</description>
</method>
Rename `uniform` to `parameter` across the engine
2022-08-27 09:22:43 +00:00
<method name="global_shader_parameter_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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="name" type="StringName" />
Rename `uniform` to `parameter` across the engine
2022-08-27 09:22:43 +00:00
<param index="1" name="type" type="int" enum="RenderingServer.GlobalShaderParameterType" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param 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 02:17:47 +00:00
<description>
</description>
</method>
Rename `uniform` to `parameter` across the engine
2022-08-27 09:22:43 +00:00
<method name="global_shader_parameter_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 13:28:05 +00:00
<return type="Variant" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param 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 02:17:47 +00:00
<description>
</description>
</method>
Rename `uniform` to `parameter` across the engine
2022-08-27 09:22:43 +00:00
<method name="global_shader_parameter_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 13:28:05 +00: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 02:17:47 +00:00
<description>
</description>
</method>
Rename `uniform` to `parameter` across the engine
2022-08-27 09:22:43 +00:00
<method name="global_shader_parameter_get_type" qualifiers="const">
<return type="int" enum="RenderingServer.GlobalShaderParameterType" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param 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 02:17:47 +00:00
<description>
</description>
</method>
Rename `uniform` to `parameter` across the engine
2022-08-27 09:22:43 +00:00
<method name="global_shader_parameter_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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param 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 02:17:47 +00:00
<description>
</description>
</method>
Rename `uniform` to `parameter` across the engine
2022-08-27 09:22:43 +00:00
<method name="global_shader_parameter_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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="name" type="StringName" />
<param 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 02:17:47 +00:00
<description>
</description>
</method>
Rename `uniform` to `parameter` across the engine
2022-08-27 09:22:43 +00:00
<method name="global_shader_parameter_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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="name" type="StringName" />
<param 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 02:17:47 +00: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 13:28:05 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="bool" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param 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 02:17:47 +00: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 13:28:05 +00:00
<return type="bool" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param 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 02:17:47 +00:00
<description>
[doc] Use "param" instead of "code" to refer to parameters (4)
2022-08-11 17:52:19 +00:00
Returns [code]true[/code] if the OS supports a certain [param feature]. Features might be [code]s3tc[/code], [code]etc[/code], and [code]etc2[/code].
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 02:17:47 +00:00
</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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="instance" type="RID" />
<param 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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="instance" type="RID" />
<param 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 02:17:47 +00: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 13:28:05 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="RID" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="base" type="RID" />
<param 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 02:17:47 +00: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>
Rename `uniform` to `parameter` across the engine
2022-08-27 09:22:43 +00:00
<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 13:28:05 +00:00
<return type="Variant" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="instance" type="RID" />
<param 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 02:17:47 +00:00
<description>
</description>
</method>
Rename `uniform` to `parameter` across the engine
2022-08-27 09:22:43 +00:00
<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 13:28:05 +00:00
<return type="Variant" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="instance" type="RID" />
<param 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 02:17:47 +00:00
<description>
</description>
</method>
Rename `uniform` to `parameter` across the engine
2022-08-27 09:22:43 +00:00
<method name="instance_geometry_get_shader_parameter_list" qualifiers="const">
Replace Array return types with TypedArray 3
2022-08-07 22:52:20 +00:00
<return type="Dictionary[]" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param 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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="instance" type="RID" />
<param 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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="instance" type="RID" />
<param index="1" name="flag" type="int" enum="RenderingServer.InstanceFlags" />
<param 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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="instance" type="RID" />
<param index="1" name="lightmap" type="RID" />
<param index="2" name="lightmap_uv_scale" type="Rect2" />
<param index="3" name="lightmap_slice" type="int" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="instance" type="RID" />
<param 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 02:17:47 +00:00
<description>
</description>
</method>
Added material_overlay property to MeshInstance3D Applying overlay materials into multi-surface meshes currently requires adding a next pass material to all the surfaces, which might be cumbersome when the material is to be applied to a range of different geometries. This also makes it not trivial to use AnimationPlayer to control the material in case of visual effects. The material_override property is not an option as it works replacing the active material for the surfaces, not adding a new pass. This commit adds the material_overlay property to GeometryInstance3D (and therefore MeshInstance3D), having the same reach as material_override (that is, all surfaces) but adding a new material pass on top of the active materials, instead of replacing them.
2021-09-25 18:40:26 +00:00
<method name="instance_geometry_set_material_overlay">
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="instance" type="RID" />
<param index="1" name="material" type="RID" />
Added material_overlay property to MeshInstance3D Applying overlay materials into multi-surface meshes currently requires adding a next pass material to all the surfaces, which might be cumbersome when the material is to be applied to a range of different geometries. This also makes it not trivial to use AnimationPlayer to control the material in case of visual effects. The material_override property is not an option as it works replacing the active material for the surfaces, not adding a new pass. This commit adds the material_overlay property to GeometryInstance3D (and therefore MeshInstance3D), having the same reach as material_override (that is, all surfaces) but adding a new material pass on top of the active materials, instead of replacing them.
2021-09-25 18:40:26 +00:00
<description>
Sets a material that will be rendered for all surfaces on top of active materials for the mesh associated with this instance. Equivalent to [member GeometryInstance3D.material_overlay].
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 02:17:47 +00:00
<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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="instance" type="RID" />
<param 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 02:17:47 +00: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>
Rename `uniform` to `parameter` across the engine
2022-08-27 09:22:43 +00:00
<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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="instance" type="RID" />
<param index="1" name="parameter" type="StringName" />
<param index="2" name="value" type="Variant" />
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 18:17:34 +00:00
<method name="instance_geometry_set_transparency">
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="instance" type="RID" />
<param index="1" name="transparency" 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 18:17:34 +00:00
<description>
Sets the transparency for the given geometry instance. Equivalent to [member GeometryInstance3D.transparency].
[doc] Use "param" instead of "code" to refer to parameters (4)
2022-08-11 17:52:19 +00:00
A transparency of [code]0.0[/code] is fully opaque, while [code]1.0[/code] is fully transparent. Values greater than [code]0.0[/code] (exclusive) will force the geometry's materials to go through the transparent pipeline, which is slower to render and can exhibit rendering issues due to incorrect transparency sorting. However, unlike using a transparent material, setting [param transparency] to a value greater than [code]0.0[/code] (exclusive) will [i]not[/i] disable shadow rendering.
Improve documentation for `GeometryInstance3D.transparency`
2022-02-11 19:18:49 +00:00
In spatial shaders, [code]1.0 - transparency[/code] is set as the default value of the [code]ALPHA[/code] built-in.
[doc] Use "param" instead of "code" to refer to parameters (4)
2022-08-11 17:52:19 +00:00
[b]Note:[/b] [param transparency] is clamped between [code]0.0[/code] and [code]1.0[/code], so this property cannot be used to make transparent materials more opaque than they originally are.
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 18:17:34 +00:00
</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 16:23:20 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="instance" type="RID" />
<param index="1" name="min" type="float" />
<param index="2" name="max" type="float" />
<param index="3" name="min_margin" type="float" />
<param index="4" name="max_margin" type="float" />
<param index="5" name="fade_mode" type="int" enum="RenderingServer.VisibilityRangeFadeMode" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="instance" type="RID" />
<param 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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="instance" type="RID" />
<param index="1" name="shape" type="int" />
<param 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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="instance" type="RID" />
<param 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 02:17:47 +00:00
<description>
Expose GeometryInstance3D.custom_aabb property
2022-12-15 17:50:14 +00:00
Sets a custom AABB to use when culling objects from the view frustum. Equivalent to setting [member GeometryInstance3D.custom_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 02:17:47 +00:00
</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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="instance" type="RID" />
<param 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 02:17:47 +00: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 11:28:55 +00:00
<method name="instance_set_ignore_culling">
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="instance" type="RID" />
<param index="1" name="enabled" type="bool" />
Addition of FogVolumes, FogShaders, FogMaterial, and overhaul of VolumetricFog Co-authored-by: Brian Semrau <brian.semrau@gmail.com>
2021-10-03 11:28:55 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="instance" type="RID" />
<param 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 02:17:47 +00:00
<description>
Sets the render layers that this instance will be drawn to. Equivalent to [member VisualInstance3D.layers].
</description>
</method>
Added options for sorting transparent objects (port of PR 63040)
2022-12-13 04:13:16 +00:00
<method name="instance_set_pivot_data">
<return type="void" />
<param index="0" name="instance" type="RID" />
<param index="1" name="sorting_offset" type="float" />
<param index="2" name="use_aabb_center" type="bool" />
<description>
Sets the sorting offset and switches between using the bounding box or instance origin for depth sorting.
</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 02:17:47 +00:00
<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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="instance" type="RID" />
<param 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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="instance" type="RID" />
<param index="1" name="surface" type="int" />
<param 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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="instance" type="RID" />
<param 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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="instance" type="RID" />
<param 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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="instance" type="RID" />
<param 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 02:17:47 +00:00
<description>
Sets whether an instance is drawn or not. Equivalent to [member Node3D.visible].
</description>
</method>
<method name="instances_cull_aabb" qualifiers="const">
Replace Array return types with TypedArray 3
2022-08-07 22:52:20 +00:00
<return type="PackedInt64Array" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="aabb" type="AABB" />
<param 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 02:17:47 +00: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">
Replace Array return types with TypedArray 3
2022-08-07 22:52:20 +00:00
<return type="PackedInt64Array" />
Change Array arguments to TypedArray
2022-08-31 17:24:04 +00:00
<param index="0" name="convex" type="Plane[]" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param 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 02:17:47 +00: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">
Replace Array return types with TypedArray 3
2022-08-07 22:52:20 +00:00
<return type="PackedInt64Array" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="from" type="Vector3" />
<param index="1" name="to" type="Vector3" />
<param 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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="light" type="RID" />
<param 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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="light" type="RID" />
<param 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 02:17:47 +00:00
<description>
Sets the shadow mode for this directional light. Equivalent to [member DirectionalLight3D.directional_shadow_mode]. See [enum LightDirectionalShadowMode] for options.
</description>
</method>
Replace DirectionalLight3D's `use_in_sky_only` with `sky_mode` enum 3 options are available: - Light and Sky (default) - Light Only (new) - Sky Only (equivalent to `use_in_sky_only = true`) Co-authored by: clayjohn <claynjohn@gmail.com>
2021-10-19 22:40:46 +00:00
<method name="light_directional_set_sky_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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="light" type="RID" />
<param index="1" name="mode" type="int" enum="RenderingServer.LightDirectionalSkyMode" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="light" type="RID" />
<param 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 02:17:47 +00: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 19:41:55 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param 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 19:41:55 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="light" type="RID" />
<param 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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="light" type="RID" />
<param 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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="light" type="RID" />
<param 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 02:17:47 +00: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>
Implement distance fade properties in OmniLight3D and SpotLight3D This can be used to fade lights and their shadows in the distance, similar to Decal nodes. This can bring significant performance improvements, especially for lights with shadows enabled and when using higher-than-default shadow quality settings. While lights can be smoothly faded out over distance, shadows are currently "all or nothing" since per-light shadow color is no longer customizable in the Vulkan renderer. This may result in noticeable pop-in when leaving the shadow cutoff distance, but depending on the scene, it may not always be that noticeable.
2022-02-24 21:55:14 +00:00
<method name="light_set_distance_fade">
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="decal" type="RID" />
<param index="1" name="enabled" type="bool" />
<param index="2" name="begin" type="float" />
<param index="3" name="shadow" type="float" />
<param index="4" name="length" type="float" />
Implement distance fade properties in OmniLight3D and SpotLight3D This can be used to fade lights and their shadows in the distance, similar to Decal nodes. This can bring significant performance improvements, especially for lights with shadows enabled and when using higher-than-default shadow quality settings. While lights can be smoothly faded out over distance, shadows are currently "all or nothing" since per-light shadow color is no longer customizable in the Vulkan renderer. This may result in noticeable pop-in when leaving the shadow cutoff distance, but depending on the scene, it may not always be that noticeable.
2022-02-24 21:55:14 +00:00
<description>
Sets the distance fade for this Light3D. This acts as a form of level of detail (LOD) and can be used to improve performance. Equivalent to [member Light3D.distance_fade_enabled], [member Light3D.distance_fade_begin], [member Light3D.distance_fade_shadow], and [member Light3D.distance_fade_length].
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 02:17:47 +00:00
<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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="light" type="RID" />
<param 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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="light" type="RID" />
<param 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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="light" type="RID" />
<param index="1" name="param" type="int" enum="RenderingServer.LightParam" />
<param 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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="light" type="RID" />
<param 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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="light" type="RID" />
<param 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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="light" type="RID" />
<param 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 02:17:47 +00:00
<description>
If [code]true[/code], light will cast shadows. Equivalent to [member Light3D.shadow_enabled].
</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 13:28:05 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="PackedInt32Array" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param 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 02:17:47 +00: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 13:28:05 +00:00
<return type="PackedVector3Array" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param 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 02:17:47 +00: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 13:28:05 +00:00
<return type="PackedColorArray" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param 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 02:17:47 +00: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 13:28:05 +00:00
<return type="PackedInt32Array" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param 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 02:17:47 +00:00
<description>
</description>
</method>
Implement Physical Light Units as an optional setting. This allows light sources to be specified in physical light units in addition to the regular energy multiplier. In order to avoid loss of precision at high values, brightness values are premultiplied by an exposure normalization value. In support of Physical Light Units this PR also renames CameraEffects to CameraAttributes.
2022-07-31 23:20:24 +00:00
<method name="lightmap_set_baked_exposure_normalization">
<return type="void" />
<param index="0" name="lightmap" type="RID" />
<param index="1" name="baked_exposure" type="float" />
<description>
Used to inform the renderer what exposure normalization value was used while baking the lightmap. This value will be used and modulated at run time to ensure that the lightmap maintains a consistent level of exposure even if the scene-wide exposure normalization is changed at run time. For more information see [method camera_attributes_set_exposure].
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 02:17:47 +00:00
<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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="lightmap" type="RID" />
<param 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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="lightmap" type="RID" />
<param index="1" name="points" type="PackedVector3Array" />
<param index="2" name="point_sh" type="PackedColorArray" />
<param index="3" name="tetrahedra" type="PackedInt32Array" />
<param index="4" name="bsp_tree" type="PackedInt32Array" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param 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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="lightmap" type="RID" />
<param 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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="lightmap" type="RID" />
<param index="1" name="light" type="RID" />
<param 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 02:17:47 +00: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 13:28:05 +00:00
<return type="RID" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="latitudes" type="int" />
<param index="1" name="longitudes" type="int" />
<param 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 02:17:47 +00:00
<description>
[doc] Fix grammar in class docs: amount vs. number Number is used for things that can be counted (discrete items - think "integer" in this context). Also fixes a couple of awkward phrases.
2022-08-17 22:08:09 +00:00
Returns a mesh of a sphere with the given number of horizontal and vertical subdivisions.
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 02:17:47 +00:00
</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 13:28:05 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="Variant" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="material" type="RID" />
<param 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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="material" type="RID" />
<param 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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="material" type="RID" />
<param index="1" name="parameter" type="StringName" />
<param 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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="material" type="RID" />
<param 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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="shader_material" type="RID" />
<param 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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="mesh" type="RID" />
<param 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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="mesh" type="RID" />
<param index="1" name="primitive" type="int" enum="RenderingServer.PrimitiveType" />
<param index="2" name="arrays" type="Array" />
<param index="3" name="blend_shapes" type="Array" default="[]" />
<param index="4" name="lods" type="Dictionary" default="{}" />
Use BitField<> hint for ArrayFormat This was missing in the conversion of bitflags to BitField<>.
2023-01-07 19:37:21 +00:00
<param index="5" name="compress_format" type="int" enum="RenderingServer.ArrayFormat" 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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param 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 02:17:47 +00: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 13:28:05 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="RID" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="surfaces" type="Dictionary[]" />
<param 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 02:17:47 +00: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 13:28:05 +00:00
<return type="int" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param 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 02:17:47 +00: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 13:28:05 +00:00
<return type="int" enum="RenderingServer.BlendShapeMode" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param 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 02:17:47 +00: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 13:28:05 +00:00
<return type="AABB" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param 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 02:17:47 +00: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 13:28:05 +00:00
<return type="Dictionary" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="mesh" type="RID" />
<param 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 02:17:47 +00: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 13:28:05 +00:00
<return type="int" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param 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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="mesh" type="RID" />
<param 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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="mesh" type="RID" />
<param 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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="mesh" type="RID" />
<param 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 02:17:47 +00: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 13:28:05 +00:00
<return type="Array" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="mesh" type="RID" />
<param 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 02:17:47 +00:00
<description>
Returns a mesh's surface's buffer arrays.
</description>
</method>
<method name="mesh_surface_get_blend_shape_arrays" qualifiers="const">
Replace Array return types with TypedArray 2
2022-08-05 18:35:08 +00:00
<return type="Array[]" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="mesh" type="RID" />
<param 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 02:17:47 +00: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 13:28:05 +00:00
<return type="int" />
Use BitField<> hint for ArrayFormat This was missing in the conversion of bitflags to BitField<>.
2023-01-07 19:37:21 +00:00
<param index="0" name="format" type="int" enum="RenderingServer.ArrayFormat" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param 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 02:17:47 +00: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 13:28:05 +00:00
<return type="int" />
Use BitField<> hint for ArrayFormat This was missing in the conversion of bitflags to BitField<>.
2023-01-07 19:37:21 +00:00
<param index="0" name="format" type="int" enum="RenderingServer.ArrayFormat" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="1" name="vertex_count" type="int" />
<param 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 02:17:47 +00: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 13:28:05 +00:00
<return type="int" />
Use BitField<> hint for ArrayFormat This was missing in the conversion of bitflags to BitField<>.
2023-01-07 19:37:21 +00:00
<param index="0" name="format" type="int" enum="RenderingServer.ArrayFormat" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param 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 02:17:47 +00: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 13:28:05 +00:00
<return type="int" />
Use BitField<> hint for ArrayFormat This was missing in the conversion of bitflags to BitField<>.
2023-01-07 19:37:21 +00:00
<param index="0" name="format" type="int" enum="RenderingServer.ArrayFormat" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param 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 02:17:47 +00: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 13:28:05 +00:00
<return type="RID" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="mesh" type="RID" />
<param 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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="mesh" type="RID" />
<param index="1" name="surface" type="int" />
<param 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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="mesh" type="RID" />
<param index="1" name="surface" type="int" />
<param index="2" name="offset" type="int" />
<param index="3" name="data" type="PackedByteArray" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="mesh" type="RID" />
<param index="1" name="surface" type="int" />
<param index="2" name="offset" type="int" />
<param index="3" name="data" type="PackedByteArray" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="mesh" type="RID" />
<param index="1" name="surface" type="int" />
<param index="2" name="offset" type="int" />
<param index="3" name="data" type="PackedByteArray" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="multimesh" type="RID" />
<param index="1" name="instances" type="int" />
<param index="2" name="transform_format" type="int" enum="RenderingServer.MultimeshTransformFormat" />
<param index="3" name="color_format" type="bool" default="false" />
<param index="4" name="custom_data_format" type="bool" default="false" />
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 02:17:47 +00: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 13:28:05 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="AABB" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param 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 02:17:47 +00: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 13:28:05 +00:00
<return type="PackedFloat32Array" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param 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 02:17:47 +00: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 13:28:05 +00:00
<return type="int" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param 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 02:17:47 +00: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 13:28:05 +00:00
<return type="RID" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param 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 02:17:47 +00: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 13:28:05 +00:00
<return type="int" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param 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 02:17:47 +00: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 13:28:05 +00:00
<return type="Color" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="multimesh" type="RID" />
<param 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 02:17:47 +00: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 13:28:05 +00:00
<return type="Color" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="multimesh" type="RID" />
<param 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 02:17:47 +00: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 13:28:05 +00:00
<return type="Transform3D" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="multimesh" type="RID" />
<param index="1" name="index" type="int" />
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 02:17:47 +00:00
Returns the [Transform3D] of the specified instance.
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="Transform2D" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="multimesh" type="RID" />
<param index="1" name="index" type="int" />
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 02:17:47 +00: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 09:47:16 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="multimesh" type="RID" />
<param index="1" name="index" type="int" />
<param index="2" name="color" type="Color" />
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 02:17:47 +00: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 09:47:16 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="multimesh" type="RID" />
<param index="1" name="index" type="int" />
<param index="2" name="custom_data" type="Color" />
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 02:17:47 +00: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 09:47:16 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="multimesh" type="RID" />
<param index="1" name="index" type="int" />
<param index="2" name="transform" type="Transform3D" />
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 02:17:47 +00:00
Sets the [Transform3D] for this instance. Equivalent to [method MultiMesh.set_instance_transform].
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="multimesh" type="RID" />
<param index="1" name="index" type="int" />
<param index="2" name="transform" type="Transform2D" />
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 02:17:47 +00: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 09:47:16 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="multimesh" type="RID" />
<param index="1" name="buffer" type="PackedFloat32Array" />
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="multimesh" type="RID" />
<param index="1" name="mesh" type="RID" />
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 02:17:47 +00:00
Sets the mesh to be drawn by the multimesh. Equivalent to [member MultiMesh.mesh].
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="multimesh" type="RID" />
<param index="1" name="visible" type="int" />
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 02:17:47 +00: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 09:47:16 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="RID" />
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="occluder" type="RID" />
<param index="1" name="vertices" type="PackedVector3Array" />
<param 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 16:23:20 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="RID" />
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 02:17:47 +00: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 09:47:16 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="RID" />
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="particles_collision" type="RID" />
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="particles_collision" type="RID" />
<param index="1" name="curve" type="float" />
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="particles_collision" type="RID" />
<param index="1" name="amount" type="float" />
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="particles_collision" type="RID" />
<param index="1" name="setrngth" type="float" />
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="particles_collision" type="RID" />
<param index="1" name="extents" type="Vector3" />
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="particles_collision" type="RID" />
<param index="1" name="type" type="int" enum="RenderingServer.ParticlesCollisionType" />
Add sky_only setting to DirectionalLight3Ds
2020-10-22 06:22:53 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="particles_collision" type="RID" />
<param index="1" name="mask" type="int" />
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="particles_collision" type="RID" />
<param 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 12:18:13 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="particles_collision" type="RID" />
<param index="1" name="resolution" type="int" enum="RenderingServer.ParticlesCollisionHeightfieldResolution" />
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="particles_collision" type="RID" />
<param index="1" name="radius" type="float" />
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="RID" />
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 02:17:47 +00: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 09:47:16 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="particles" type="RID" />
<param index="1" name="transform" type="Transform3D" />
<param index="2" name="velocity" type="Vector3" />
<param index="3" name="color" type="Color" />
<param index="4" name="custom" type="Color" />
<param index="5" name="emit_flags" type="int" />
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="AABB" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="particles" type="RID" />
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 02:17:47 +00: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 09:47:16 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="bool" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param 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 02:17:47 +00: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 13:28:05 +00:00
<return type="bool" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="particles" type="RID" />
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 02:17:47 +00: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 09:47:16 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="particles" type="RID" />
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 02:17:47 +00: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 09:47:16 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="particles" type="RID" />
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 02:17:47 +00:00
Reset the particles on the next update. Equivalent to [method GPUParticles3D.restart].
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="particles" type="RID" />
<param index="1" name="amount" type="int" />
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 02:17:47 +00: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 09:47:16 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="particles" type="RID" />
<param index="1" name="size" type="float" />
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="particles" type="RID" />
<param index="1" name="aabb" type="AABB" />
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 02:17:47 +00: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 09:47:16 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="particles" type="RID" />
<param index="1" name="order" type="int" enum="RenderingServer.ParticlesDrawOrder" />
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 02:17:47 +00: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 09:47:16 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="particles" type="RID" />
<param index="1" name="pass" type="int" />
<param index="2" name="mesh" type="RID" />
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 02:17:47 +00: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 09:47:16 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="particles" type="RID" />
<param index="1" name="count" type="int" />
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 02:17:47 +00:00
Sets the number of draw passes to use. Equivalent to [member GPUParticles3D.draw_passes].
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="particles" type="RID" />
<param index="1" name="transform" type="Transform3D" />
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 02:17:47 +00:00
Sets the [Transform3D] that will be used by the particles when they first emit.
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="particles" type="RID" />
<param index="1" name="emitting" type="bool" />
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 02:17:47 +00: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 09:47:16 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="particles" type="RID" />
<param index="1" name="ratio" type="float" />
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 02:17:47 +00:00
Sets the explosiveness ratio. Equivalent to [member GPUParticles3D.explosiveness].
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="particles" type="RID" />
<param index="1" name="fps" type="int" />
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 02:17:47 +00: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 09:47:16 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="particles" type="RID" />
<param index="1" name="enable" type="bool" />
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 02:17:47 +00: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 09:47:16 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="particles" type="RID" />
<param index="1" name="enable" type="bool" />
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="particles" type="RID" />
<param index="1" name="lifetime" type="float" />
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 02:17:47 +00:00
Sets the lifetime of each particle in the system. Equivalent to [member GPUParticles3D.lifetime].
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="particles" type="RID" />
<param index="1" name="mode" type="int" enum="RenderingServer.ParticlesMode" />
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="particles" type="RID" />
<param index="1" name="one_shot" type="bool" />
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 02:17:47 +00: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 09:47:16 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="particles" type="RID" />
<param index="1" name="time" type="float" />
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 02:17:47 +00: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 09:47:16 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="particles" type="RID" />
<param index="1" name="material" type="RID" />
doc: Sync classref with current source
2018-02-19 09:47:16 +00:00
<description>
doc: Fix style inconsistencies for `[b]Note:[/b]` paragraphs And fix up formatting not supported by makerst.
2021-10-05 12:24:34 +00: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 09:47:16 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="particles" type="RID" />
<param 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 14:54:48 +00: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 02:17:47 +00: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 14:54:48 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="particles" type="RID" />
<param index="1" name="scale" type="float" />
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 09:56:21 +00: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 02:17:47 +00: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 09:56:21 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="particles" type="RID" />
<param 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 14:54:48 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="particles" type="RID" />
<param index="1" name="bind_poses" type="Transform3D[]" />
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 09:56:21 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="particles" type="RID" />
<param index="1" name="enable" type="bool" />
<param index="2" name="length_sec" type="float" />
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="particles" type="RID" />
<param index="1" name="align" type="int" enum="RenderingServer.ParticlesTransformAlign" />
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="particles" type="RID" />
<param index="1" name="enable" type="bool" />
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 02:17:47 +00: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 09:47:16 +00:00
</description>
</method>
Rename soft shadow quality project settings for easier searching `rendering/quality/shadows` is now `rendering/quality/positional_shadow` to explicitly denote that the settings only affect positional light shadows, not directional light shadows. Shadow atlas settings now contain the word "atlas" for easier searching. Soft shadow quality settings were renamed to contain the word "filter". This makes the settings appear when searching for "filter" in the project settings dialog, like in Godot 3.x.
2022-04-30 23:40:30 +00:00
<method name="positional_soft_shadow_filter_set_quality">
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="quality" type="int" enum="RenderingServer.ShadowQuality" />
Rename soft shadow quality project settings for easier searching `rendering/quality/shadows` is now `rendering/quality/positional_shadow` to explicitly denote that the settings only affect positional light shadows, not directional light shadows. Shadow atlas settings now contain the word "atlas" for easier searching. Soft shadow quality settings were renamed to contain the word "filter". This makes the settings appear when searching for "filter" in the project settings dialog, like in Godot 3.x.
2022-04-30 23:40:30 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="RID" />
Added method binding for `multimesh_create` that was missing from VisualServer class.
2019-12-01 05:47:16 +00: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 02:17:47 +00: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 16:22:57 +00: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 02:17:47 +00: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 05:47:16 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="probe" type="RID" />
<param 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 08:59:06 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="probe" type="RID" />
<param index="1" name="energy" type="float" />
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="probe" type="RID" />
<param index="1" name="mode" type="int" enum="RenderingServer.ReflectionProbeAmbientMode" />
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="probe" type="RID" />
<param index="1" name="enable" type="bool" />
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 02:17:47 +00:00
If [code]true[/code], reflections will ignore sky contribution. Equivalent to [member ReflectionProbe.interior].
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="probe" type="RID" />
<param index="1" name="layers" type="int" />
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 02:17:47 +00: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 09:47:16 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="probe" type="RID" />
<param index="1" name="enable" type="bool" />
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 09:56:21 +00: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 02:17:47 +00: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 09:56:21 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="probe" type="RID" />
<param index="1" name="enable" type="bool" />
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 02:17:47 +00: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 09:47:16 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="probe" type="RID" />
<param index="1" name="extents" type="Vector3" />
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 02:17:47 +00: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 09:47:16 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="probe" type="RID" />
<param index="1" name="intensity" type="float" />
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 02:17:47 +00: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 09:47:16 +00:00
</description>
</method>
Rename Lod Threshold to Mesh Lod Threshold This makes it more obvious that the setting only affects mesh LOD, not manual (H)LOD achieved using visibility ranges.
2021-12-28 23:10:41 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="probe" type="RID" />
<param index="1" name="distance" type="float" />
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 09:56:21 +00:00
<description>
Rename Lod Threshold to Mesh Lod Threshold This makes it more obvious that the setting only affects mesh LOD, not manual (H)LOD achieved using visibility ranges.
2021-12-28 23:10:41 +00: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 Fix various missing arguments in bindings.
2018-07-26 09:56:21 +00:00
</description>
</method>
Rename Lod Threshold to Mesh Lod Threshold This makes it more obvious that the setting only affects mesh LOD, not manual (H)LOD achieved using visibility ranges.
2021-12-28 23:10:41 +00:00
<method name="reflection_probe_set_mesh_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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="probe" type="RID" />
<param index="1" name="pixels" type="float" />
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="probe" type="RID" />
<param index="1" name="offset" type="Vector3" />
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 02:17:47 +00: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 09:47:16 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="probe" type="RID" />
<param index="1" name="resolution" type="int" />
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 09:56:21 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="probe" type="RID" />
<param index="1" name="mode" type="int" enum="RenderingServer.ReflectionProbeUpdateMode" />
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 02:17:47 +00: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 09:47:16 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="callable" type="Callable" />
doc: Sync classref with current source
2018-02-19 09:47:16 +00:00
<description>
Use Callable in RS::request_frame_drawn_callback
2021-11-05 05:59:38 +00:00
Schedules a callback to the given callable after a frame has been drawn.
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 02:17:47 +00: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 13:28:05 +00: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 16:40:24 +00: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 02:17:47 +00: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 16:40:24 +00:00
</description>
</method>
Implement Physical Light Units as an optional setting. This allows light sources to be specified in physical light units in addition to the regular energy multiplier. In order to avoid loss of precision at high values, brightness values are premultiplied by an exposure normalization value. In support of Physical Light Units this PR also renames CameraEffects to CameraAttributes.
2022-07-31 23:20:24 +00:00
<method name="scenario_set_camera_attributes">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="scenario" type="RID" />
<param 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 16:40:24 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="scenario" type="RID" />
<param index="1" name="environment" type="RID" />
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 02:17:47 +00:00
Sets the environment that will be used with this scenario.
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="scenario" type="RID" />
<param index="1" name="environment" type="RID" />
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 02:17:47 +00: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 09:47:16 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="enable" type="bool" />
<param index="1" name="amount" type="float" />
<param index="2" name="limit" type="float" />
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="image" type="Image" />
<param index="1" name="color" type="Color" />
<param index="2" name="scale" type="bool" />
<param index="3" name="use_filter" type="bool" default="true" />
doc: Sync classref with current source
2018-02-19 09:47:16 +00:00
<description>
[doc] Use "param" instead of "code" to refer to parameters (4)
2022-08-11 17:52:19 +00:00
Sets a boot image. The color defines the background color. If [param scale] is [code]true[/code], the image will be scaled to fit the screen size. If [param use_filter] is [code]true[/code], the image will be scaled with linear interpolation. If [param use_filter] is [code]false[/code], the image will be scaled with nearest-neighbor interpolation.
doc: Sync classref with current source
2018-02-19 09:47:16 +00:00
</description>
doc: Sync classref with current source
2019-11-11 16:25:05 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="generate" type="bool" />
doc: Sync classref with current source
2019-11-11 16:25:05 +00: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 02:17:47 +00: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 16:25:05 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="color" type="Color" />
doc: Sync classref with current source
2019-11-11 16:25:05 +00: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 02:17:47 +00: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 16:25:05 +00:00
</description>
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 02:17:47 +00: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 13:28:05 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="String" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="shader" type="RID" />
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 02:17:47 +00:00
Returns a shader's code.
doc: Sync classref with current source
2018-02-19 09:47:16 +00:00
</description>
</method>
Rename `uniform` to `parameter` across the engine
2022-08-27 09:22:43 +00:00
<method name="shader_get_default_texture_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 13:28:05 +00:00
<return type="RID" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="shader" type="RID" />
Rename `uniform` to `parameter` across the engine
2022-08-27 09:22:43 +00:00
<param index="1" name="name" type="StringName" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="2" name="index" type="int" default="0" />
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 02:17:47 +00:00
Returns a default texture from a shader searched by name.
[doc] Use "param" instead of "code" to refer to parameters (4)
2022-08-11 17:52:19 +00:00
[b]Note:[/b] If the sampler array is used use [param index] to access the specified texture.
doc: Sync classref with current source
2018-02-19 09:47:16 +00:00
</description>
</method>
Rename `uniform` to `parameter` across the engine
2022-08-27 09:22:43 +00:00
<method name="shader_get_parameter_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 13:28:05 +00:00
<return type="Variant" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="shader" type="RID" />
Rename `uniform` to `parameter` across the engine
2022-08-27 09:22:43 +00:00
<param index="1" name="name" type="StringName" />
doc: Sync classref with current source
2018-02-19 09:47:16 +00:00
<description>
</description>
</method>
Clean up Shader Preprocessor * Moved preprocessor to Shader and ShaderInclude * Clean up RenderingServer side * Preprocessor is separate from parser now, but it emits tokens with include location hints. * Improved ShaderEditor validation code * Added include file code completion * Added notification for all files affected by a broken include.
2022-06-29 09:31:18 +00:00
<method name="shader_set_code">
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="shader" type="RID" />
<param index="1" name="code" type="String" />
Clean up Shader Preprocessor * Moved preprocessor to Shader and ShaderInclude * Clean up RenderingServer side * Preprocessor is separate from parser now, but it emits tokens with include location hints. * Improved ShaderEditor validation code * Added include file code completion * Added notification for all files affected by a broken include.
2022-06-29 09:31:18 +00:00
<description>
</description>
</method>
Rename `uniform` to `parameter` across the engine
2022-08-27 09:22:43 +00:00
<method name="shader_set_default_texture_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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="shader" type="RID" />
Rename `uniform` to `parameter` across the engine
2022-08-27 09:22:43 +00:00
<param index="1" name="name" type="StringName" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="2" name="texture" type="RID" />
<param index="3" name="index" type="int" default="0" />
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 02:17:47 +00:00
Sets a shader's default texture. Overwrites the texture given by name.
[doc] Use "param" instead of "code" to refer to parameters (4)
2022-08-11 17:52:19 +00:00
[b]Note:[/b] If the sampler array is used use [param index] to access the specified texture.
doc: Sync classref with current source
2018-02-19 09:47:16 +00:00
</description>
</method>
Clean up Shader Preprocessor * Moved preprocessor to Shader and ShaderInclude * Clean up RenderingServer side * Preprocessor is separate from parser now, but it emits tokens with include location hints. * Improved ShaderEditor validation code * Added include file code completion * Added notification for all files affected by a broken include.
2022-06-29 09:31:18 +00:00
<method name="shader_set_path_hint">
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="shader" type="RID" />
<param index="1" name="path" type="String" />
Clean up Shader Preprocessor * Moved preprocessor to Shader and ShaderInclude * Clean up RenderingServer side * Preprocessor is separate from parser now, but it emits tokens with include location hints. * Improved ShaderEditor validation code * Added include file code completion * Added notification for all files affected by a broken include.
2022-06-29 09:31:18 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="skeleton" type="RID" />
<param index="1" name="bones" type="int" />
<param index="2" name="is_2d_skeleton" type="bool" default="false" />
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="Transform3D" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="skeleton" type="RID" />
<param index="1" name="bone" type="int" />
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 02:17:47 +00:00
Returns the [Transform3D] set for a specific bone of this skeleton.
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="Transform2D" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="skeleton" type="RID" />
<param 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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="skeleton" type="RID" />
<param index="1" name="bone" type="int" />
<param index="2" name="transform" type="Transform3D" />
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 02:17:47 +00:00
Sets the [Transform3D] for a specific bone of this skeleton.
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="skeleton" type="RID" />
<param index="1" name="bone" type="int" />
<param index="2" name="transform" type="Transform2D" />
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 02:17:47 +00:00
Sets the [Transform2D] for a specific bone of this skeleton.
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="RID" />
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 02:17:47 +00: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 09:47:16 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="int" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="skeleton" type="RID" />
classref: Sync with current source
2017-10-21 10:02:08 +00: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 02:17:47 +00:00
Returns the number of bones allocated for this skeleton.
classref: Sync with current source
2017-10-21 10:02:08 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="skeleton" type="RID" />
<param index="1" name="base_transform" type="Transform2D" />
classref: Sync with current source
2017-10-21 10:02:08 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="Image" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="sky" type="RID" />
<param index="1" name="energy" type="float" />
<param index="2" name="bake_irradiance" type="bool" />
<param index="3" name="size" type="Vector2i" />
classref: Sync with current source
2017-10-21 10:02:08 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="RID" />
classref: Sync with current source
2017-10-21 10:02:08 +00: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 02:17:47 +00: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 10:02:08 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="sky" type="RID" />
<param index="1" name="material" type="RID" />
classref: Sync with current source
2017-10-21 10:02:08 +00: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 02:17:47 +00:00
Sets the material that the sky uses to render the background and reflection maps.
classref: Sync with current source
2017-10-21 10:02:08 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="sky" type="RID" />
<param index="1" name="mode" type="int" enum="RenderingServer.SkyMode" />
classref: Sync with current source
2017-10-21 10:02:08 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="sky" type="RID" />
<param index="1" name="radiance_size" type="int" />
classref: Sync with current source
2017-10-21 10:02:08 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="RID" />
classref: Sync with current source
2017-10-21 10:02:08 +00: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 02:17:47 +00: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 16:22:57 +00: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 02:17:47 +00: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 10:02:08 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="quality" type="int" enum="RenderingServer.SubSurfaceScatteringQuality" />
classref: Sync with current source
2017-10-21 10:02:08 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="scale" type="float" />
<param index="1" name="depth_scale" type="float" />
classref: Sync with current source
2017-10-21 10:02:08 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="RID" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="image" type="Image" />
classref: Sync with current source
2017-10-21 10:02:08 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="Image" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="texture" type="RID" />
classref: Sync with current source
2017-10-21 10:02:08 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="Image" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="texture" type="RID" />
<param index="1" name="layer" type="int" />
classref: Sync with current source
2017-10-21 10:02:08 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="RID" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="layers" type="Image[]" />
<param index="1" name="layered_type" type="int" enum="RenderingServer.TextureLayeredType" />
classref: Sync with current source
2017-10-21 10:02:08 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="RID" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="layered_type" type="int" enum="RenderingServer.TextureLayeredType" />
classref: Sync with current source
2017-10-21 10:02:08 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="RID" />
classref: Sync with current source
2017-10-21 10:02:08 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="texture" type="RID" />
<param index="1" name="image" type="Image" />
<param index="2" name="layer" type="int" />
classref: Sync with current source
2017-10-21 10:02:08 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="RID" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="format" type="int" enum="Image.Format" />
<param index="1" name="width" type="int" />
<param index="2" name="height" type="int" />
<param index="3" name="depth" type="int" />
<param index="4" name="mipmaps" type="bool" />
<param index="5" name="data" type="Image[]" />
classref: Sync with current source
2017-10-21 10:02:08 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="Image[]" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="texture" type="RID" />
classref: Sync with current source
2017-10-21 10:02:08 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="RID" />
classref: Sync with current source
2017-10-21 10:02:08 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="texture" type="RID" />
<param 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 02:17:47 +00: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 13:28:05 +00:00
<return type="String" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="texture" type="RID" />
classref: Sync with current source
2017-10-21 10:02:08 +00:00
<description>
</description>
</method>
Expose texture_get_rd_texture
2022-11-01 17:50:36 +00:00
<method name="texture_get_rd_texture" qualifiers="const">
<return type="RID" />
<param index="0" name="texture" type="RID" />
<param index="1" name="srgb" type="bool" default="false" />
<description>
Returns a texture [RID] that can be used with [RenderingDevice].
</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 02:17:47 +00: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 13:28:05 +00:00
<return type="RID" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="base" type="RID" />
classref: Sync with current source
2017-10-21 10:02:08 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="texture" type="RID" />
<param 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 16:40:24 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="texture" type="RID" />
<param index="1" name="by_texture" type="RID" />
classref: Sync with current source
2017-10-21 10:02:08 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="texture" type="RID" />
<param index="1" name="enable" type="bool" />
classref: Sync with current source
2017-10-21 10:02:08 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="texture" type="RID" />
<param index="1" name="path" type="String" />
classref: Sync with current source
2017-10-21 10:02:08 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="texture" type="RID" />
<param index="1" name="width" type="int" />
<param 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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="viewport" type="RID" />
<param index="1" name="camera" type="RID" />
classref: Sync with current source
2017-10-21 10:02:08 +00: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 02:17:47 +00:00
Sets a viewport's camera.
classref: Sync with current source
2017-10-21 10:02:08 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="viewport" type="RID" />
<param index="1" name="canvas" type="RID" />
classref: Sync with current source
2017-10-21 10:02:08 +00: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 02:17:47 +00:00
Sets a viewport's canvas.
classref: Sync with current source
2017-10-21 10:02:08 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="viewport" type="RID" />
<param index="1" name="rect" type="Rect2" default="Rect2(0, 0, 0, 0)" />
<param index="2" name="screen" type="int" default="0" />
classref: Sync with current source
2017-10-21 10:02:08 +00:00
<description>
[doc] Use "param" instead of "code" to refer to parameters (4)
2022-08-11 17:52:19 +00:00
Copies the viewport to a region of the screen specified by [param rect]. If [method viewport_set_render_direct_to_screen] is [code]true[/code], then the viewport does not use a framebuffer and the contents of the viewport are rendered directly to screen. However, note that the root viewport is drawn last, therefore it will draw over the screen. Accordingly, you must set the root viewport to an area that does not cover the area that you have attached this viewport to.
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 02:17:47 +00:00
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]
i18n: Misc fixes translation strings Adds some translator comments to solve some questions raised on Weblate.
2022-06-08 09:42:51 +00:00
Using this can result in significant optimization, especially on lower-end devices. However, it comes at the cost of having to manage your viewports manually. For further optimization, see [method viewport_set_render_direct_to_screen].
classref: Sync with current source
2017-10-21 10:02:08 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="RID" />
classref: Sync with current source
2017-10-21 10:02:08 +00: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 02:17:47 +00: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 16:22:57 +00: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 10:02:08 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="float" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param 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 02:17:47 +00: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 13:28:05 +00:00
<return type="float" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="viewport" type="RID" />
classref: Sync with current source
2017-10-21 10:02:08 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="int" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="viewport" type="RID" />
<param index="1" name="type" type="int" enum="RenderingServer.ViewportRenderInfoType" />
<param index="2" name="info" type="int" enum="RenderingServer.ViewportRenderInfo" />
classref: Sync with current source
2017-10-21 10:02:08 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="RID" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param 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 08:59:06 +00: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 02:17:47 +00: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 08:59:06 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="viewport" type="RID" />
<param index="1" name="canvas" type="RID" />
classref: Sync with current source
2017-10-21 10:02:08 +00: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 02:17:47 +00:00
Detaches a viewport from a canvas and vice versa.
classref: Sync with current source
2017-10-21 10:02:08 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="viewport" type="RID" />
<param index="1" name="active" type="bool" />
classref: Sync with current source
2017-10-21 10:02:08 +00: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 02:17:47 +00:00
If [code]true[/code], sets the viewport active, else sets it inactive.
classref: Sync with current source
2017-10-21 10:02:08 +00:00
</description>
</method>
Viewport canvas cull mask feature Co-authored-by: Valentin Zagura <puthre@gmail.com>
2021-09-02 18:07:04 +00:00
<method name="viewport_set_canvas_cull_mask">
<return type="void" />
<param index="0" name="viewport" type="RID" />
<param index="1" name="canvas_cull_mask" type="int" />
<description>
Sets the rendering mask associated with this [Viewport]. Only [CanvasItem] nodes with a matching rendering visibility layer will be rendered by this [Viewport].
</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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="viewport" type="RID" />
<param index="1" name="canvas" type="RID" />
<param index="2" name="layer" type="int" />
<param index="3" name="sublayer" type="int" />
classref: Sync with current source
2017-10-21 10:02:08 +00: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 02:17:47 +00:00
Sets the stacking order for a viewport's canvas.
[doc] Use "param" instead of "code" to refer to parameters (4)
2022-08-11 17:52:19 +00:00
[param layer] is the actual canvas layer, while [param sublayer] specifies the stacking order of the canvas among those in the same layer.
classref: Sync with current source
2017-10-21 10:02:08 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="viewport" type="RID" />
<param index="1" name="canvas" type="RID" />
<param index="2" name="offset" type="Transform2D" />
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 02:17:47 +00:00
Sets the transformation of a viewport's canvas.
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="viewport" type="RID" />
<param index="1" name="clear_mode" type="int" enum="RenderingServer.ViewportClearMode" />
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 02:17:47 +00:00
Sets the clear mode of a viewport. See [enum ViewportClearMode] for options.
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="viewport" type="RID" />
<param index="1" name="draw" type="int" enum="RenderingServer.ViewportDebugDraw" />
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 02:17:47 +00:00
Sets the debug draw mode of a viewport. See [enum ViewportDebugDraw] for options.
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="viewport" type="RID" />
<param index="1" name="filter" type="int" enum="RenderingServer.CanvasItemTextureFilter" />
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="viewport" type="RID" />
<param index="1" name="repeat" type="int" enum="RenderingServer.CanvasItemTextureRepeat" />
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="viewport" type="RID" />
<param index="1" name="disable" type="bool" />
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 02:17:47 +00:00
If [code]true[/code], the viewport's canvas is not rendered.
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="viewport" type="RID" />
<param index="1" name="disable" type="bool" />
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="viewport" type="RID" />
<param index="1" name="disabled" type="bool" />
classref: Sync with current source
2017-10-21 10:02:08 +00: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 02:17:47 +00:00
If [code]true[/code], rendering of a viewport's environment is disabled.
classref: Sync with current source
2017-10-21 10:02:08 +00:00
</description>
</method>
Implemented AMD's FSR as a computer shader for upscaling 3D scenes
2021-11-23 21:16:03 +00:00
<method name="viewport_set_fsr_sharpness">
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="viewport" type="RID" />
<param index="1" name="sharpness" type="float" />
Implemented AMD's FSR as a computer shader for upscaling 3D scenes
2021-11-23 21:16:03 +00:00
<description>
Determines how sharp the upscaled image will be when using the FSR upscaling mode. Sharpness halves with every whole number. Values go from 0.0 (sharpest) to 2.0. Values above 2.0 won't make a visible difference.
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="viewport" type="RID" />
<param index="1" name="transform" type="Transform2D" />
classref: Sync with current source
2017-10-21 10:02:08 +00: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 02:17:47 +00:00
Sets the viewport's global transformation matrix.
classref: Sync with current source
2017-10-21 10:02:08 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="viewport" type="RID" />
<param index="1" name="enable" type="bool" />
doc: Sync classref with current source
2018-02-19 09:47:16 +00:00
<description>
</description>
</method>
Implement MSAA for 2D [Vulkan only]
2022-08-12 23:02:32 +00:00
<method name="viewport_set_msaa_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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="viewport" type="RID" />
<param index="1" name="msaa" type="int" enum="RenderingServer.ViewportMSAA" />
classref: Sync with current source
2017-10-21 10:02:08 +00:00
<description>
Implement MSAA for 2D [Vulkan only]
2022-08-12 23:02:32 +00:00
Sets the multisample anti-aliasing mode for 2D/Canvas. See [enum ViewportMSAA] for options.
</description>
</method>
<method name="viewport_set_msaa_3d">
<return type="void" />
<param index="0" name="viewport" type="RID" />
<param index="1" name="msaa" type="int" enum="RenderingServer.ViewportMSAA" />
<description>
Sets the multisample anti-aliasing mode for 3D. See [enum ViewportMSAA] for options.
classref: Sync with current source
2017-10-21 10:02:08 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="quality" type="int" enum="RenderingServer.ViewportOcclusionCullingBuildQuality" />
classref: Sync with current source
2017-10-21 10:02:08 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="rays_per_thread" type="int" />
classref: Sync with current source
2017-10-21 10:02:08 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="viewport" type="RID" />
<param index="1" name="parent_viewport" type="RID" />
classref: Sync with current source
2017-10-21 10:02:08 +00: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 02:17:47 +00:00
Sets the viewport's parent to another viewport.
classref: Sync with current source
2017-10-21 10:02:08 +00:00
</description>
</method>
Rename soft shadow quality project settings for easier searching `rendering/quality/shadows` is now `rendering/quality/positional_shadow` to explicitly denote that the settings only affect positional light shadows, not directional light shadows. Shadow atlas settings now contain the word "atlas" for easier searching. Soft shadow quality settings were renamed to contain the word "filter". This makes the settings appear when searching for "filter" in the project settings dialog, like in Godot 3.x.
2022-04-30 23:40:30 +00:00
<method name="viewport_set_positional_shadow_atlas_quadrant_subdivision">
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="viewport" type="RID" />
<param index="1" name="quadrant" type="int" />
<param index="2" name="subdivision" type="int" />
Rename soft shadow quality project settings for easier searching `rendering/quality/shadows` is now `rendering/quality/positional_shadow` to explicitly denote that the settings only affect positional light shadows, not directional light shadows. Shadow atlas settings now contain the word "atlas" for easier searching. Soft shadow quality settings were renamed to contain the word "filter". This makes the settings appear when searching for "filter" in the project settings dialog, like in Godot 3.x.
2022-04-30 23:40:30 +00:00
<description>
Sets the shadow atlas quadrant's subdivision.
</description>
</method>
<method name="viewport_set_positional_shadow_atlas_size">
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="viewport" type="RID" />
<param index="1" name="size" type="int" />
<param index="2" name="use_16_bits" type="bool" default="false" />
Rename soft shadow quality project settings for easier searching `rendering/quality/shadows` is now `rendering/quality/positional_shadow` to explicitly denote that the settings only affect positional light shadows, not directional light shadows. Shadow atlas settings now contain the word "atlas" for easier searching. Soft shadow quality settings were renamed to contain the word "filter". This makes the settings appear when searching for "filter" in the project settings dialog, like in Godot 3.x.
2022-04-30 23:40:30 +00:00
<description>
Sets the size of the shadow atlas's images (used for omni and spot lights). The value will be rounded up to the nearest power of 2.
[b]Note:[/b] If this is set to [code]0[/code], no shadows will be visible at all (including directional shadows).
</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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="viewport" type="RID" />
<param index="1" name="enabled" type="bool" />
classref: Sync with current source
2017-10-21 10:02:08 +00:00
<description>
Remove SCREEN_TEXTURE, DEPTH_TEXTURE, and NORMAL_ROUGHNESS_TEXTURE in favour of texture hints
2023-01-05 19:55:59 +00: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 screen_texture. You also lose the benefit of certain window settings, such as the various stretch modes. Another consequence to be aware of is that in 2D the rendering happens in window coordinates, so if you have a viewport that is double the size of the window, and you set this, then only the portion that fits within the window will be drawn, no automatic scaling is possible, even if your game scene is significantly larger than the window size.
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 20:42:36 +00:00
</description>
</method>
Implemented AMD's FSR as a computer shader for upscaling 3D scenes
2021-11-23 21:16:03 +00:00
<method name="viewport_set_scaling_3d_mode">
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="viewport" type="RID" />
<param index="1" name="scaling_3d_mode" type="int" enum="RenderingServer.ViewportScaling3DMode" />
Implemented AMD's FSR as a computer shader for upscaling 3D scenes
2021-11-23 21:16:03 +00:00
<description>
Sets scaling 3d mode. Bilinear scaling renders at different resolution to either undersample or supersample the viewport. FidelityFX Super Resolution 1.0, abbreviated to FSR, is an upscaling technology that produces high quality images at fast framerates by using a spatially aware upscaling algorithm. FSR is slightly more expensive than bilinear, but it produces significantly higher image quality. FSR should be used where possible.
</description>
</method>
<method name="viewport_set_scaling_3d_scale">
Optionally scale 3D render content
2021-08-19 01:52:06 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="viewport" type="RID" />
<param index="1" name="scale" type="float" />
Optionally scale 3D render content
2021-08-19 01:52:06 +00:00
<description>
Implemented AMD's FSR as a computer shader for upscaling 3D scenes
2021-11-23 21:16:03 +00:00
Scales the 3D render buffer based on the viewport size uses an image filter specified in [enum ViewportScaling3DMode] to scale the output image to the full viewport size. Values lower than [code]1.0[/code] can be used to speed up 3D rendering at the cost of quality (undersampling). Values greater than [code]1.0[/code] are only valid for bilinear mode and can be used to improve 3D rendering quality at a high performance cost (supersampling). See also [enum ViewportMSAA] for multi-sample antialiasing, which is significantly cheaper but only smoothens the edges of polygons.
When using FSR upscaling, AMD recommends exposing the following values as preset options to users "Ultra Quality: 0.77", "Quality: 0.67", "Balanced: 0.59", "Performance: 0.5" instead of exposing the entire scale.
Optionally scale 3D render content
2021-08-19 01:52:06 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="viewport" type="RID" />
<param index="1" name="scenario" type="RID" />
doc: Sync classref with current source
2021-01-04 13:33:44 +00: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 02:17:47 +00: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 13:33:44 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="viewport" type="RID" />
<param index="1" name="mode" type="int" enum="RenderingServer.ViewportScreenSpaceAA" />
doc: Sync classref with current source
2021-01-04 13:33:44 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="viewport" type="RID" />
<param index="1" name="oversize" type="int" enum="RenderingServer.ViewportSDFOversize" />
<param index="2" name="scale" type="int" enum="RenderingServer.ViewportSDFScale" />
classref: Sync with current source
2017-10-21 10:02:08 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="viewport" type="RID" />
<param index="1" name="width" type="int" />
<param 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 20:42:36 +00: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 02:17:47 +00: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 20:42:36 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="viewport" type="RID" />
<param 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 20:42:36 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="viewport" type="RID" />
<param 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 20:42:36 +00:00
<description>
</description>
</method>
Allow changing mipmap LOD bias when FSR 1.0 scaling is not used Mipmap LOD bias can be useful to improve the appearance of distant textures without increasing anisotropic filtering (or in situations where anisotropic filtering is not effective). `fsr_mipmap_bias` was renamed to `texture_mipmap_bias` accordingly. The property hint now allows for greater precision as well.
2022-06-11 23:49:59 +00:00
<method name="viewport_set_texture_mipmap_bias">
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="viewport" type="RID" />
<param index="1" name="mipmap_bias" type="float" />
Allow changing mipmap LOD bias when FSR 1.0 scaling is not used Mipmap LOD bias can be useful to improve the appearance of distant textures without increasing anisotropic filtering (or in situations where anisotropic filtering is not effective). `fsr_mipmap_bias` was renamed to `texture_mipmap_bias` accordingly. The property hint now allows for greater precision as well.
2022-06-11 23:49:59 +00:00
<description>
Affects the final texture sharpness by reading from a lower or higher mipmap (also called "texture LOD bias"). Negative values make mipmapped textures sharper but grainier when viewed at a distance, while positive values make mipmapped textures blurrier (even when up close). To get sharper textures at a distance without introducing too much graininess, set this between [code]-0.75[/code] and [code]0.0[/code]. Enabling temporal antialiasing ([member ProjectSettings.rendering/anti_aliasing/quality/use_taa]) can help reduce the graininess visible when using negative mipmap bias.
[b]Note:[/b] When the 3D scaling mode is set to FSR 1.0, this value is used to adjust the automatic mipmap bias which is calculated internally based on the scale factor. The formula for this is [code]-log2(1.0 / scale) + mipmap_bias[/code].
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="viewport" type="RID" />
<param 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 20:42:36 +00: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 02:17:47 +00:00
If [code]true[/code], the viewport renders its background as transparent.
classref: Sync with current source
2017-10-21 10:02:08 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="viewport" type="RID" />
<param index="1" name="update_mode" type="int" enum="RenderingServer.ViewportUpdateMode" />
classref: Sync with current source
2017-10-21 10:02:08 +00: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 02:17:47 +00:00
Sets when the viewport should be updated. See [enum ViewportUpdateMode] constants for options.
classref: Sync with current source
2017-10-21 10:02:08 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="viewport" type="RID" />
<param index="1" name="enable" type="bool" />
classref: Sync with current source
2017-10-21 10:02:08 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="viewport" type="RID" />
<param index="1" name="enable" type="bool" />
classref: Sync with current source
2017-10-21 10:02:08 +00:00
<description>
</description>
</method>
Initial TAA implementation Initial TAA support based on the implementation in Spartan Engine. Motion vectors are correctly generated for camera and mesh movement, but there is no support for other things like particles or skeleton deformations.
2022-04-04 14:10:22 +00:00
<method name="viewport_set_use_taa">
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="viewport" type="RID" />
<param index="1" name="enable" type="bool" />
Initial TAA implementation Initial TAA support based on the implementation in Spartan Engine. Motion vectors are correctly generated for camera and mesh movement, but there is no support for other things like particles or skeleton deformations.
2022-04-04 14:10:22 +00:00
<description>
If [code]true[/code], use Temporal Anti-Aliasing.
</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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="viewport" type="RID" />
<param index="1" name="use_xr" type="bool" />
classref: Sync with current source
2017-10-21 10:02:08 +00: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 02:17:47 +00:00
If [code]true[/code], the viewport uses augmented or virtual reality technologies. See [XRInterface].
</description>
</method>
Adding Variable Rate Shading support to Godot Improve GI renderer and add VRS support Implement render device has_feature and move subgroup settings to limit_get
2022-02-11 11:33:54 +00:00
<method name="viewport_set_vrs_mode">
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="viewport" type="RID" />
<param index="1" name="mode" type="int" enum="RenderingServer.ViewportVRSMode" />
Adding Variable Rate Shading support to Godot Improve GI renderer and add VRS support Implement render device has_feature and move subgroup settings to limit_get
2022-02-11 11:33:54 +00:00
<description>
Sets the Variable Rate Shading (VRS) mode for the viewport. Note, if hardware does not support VRS this property is ignored.
</description>
</method>
<method name="viewport_set_vrs_texture">
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="viewport" type="RID" />
<param index="1" name="texture" type="RID" />
Adding Variable Rate Shading support to Godot Improve GI renderer and add VRS support Implement render device has_feature and move subgroup settings to limit_get
2022-02-11 11:33:54 +00:00
<description>
Texture to use when the VRS mode is set to [constant RenderingServer.VIEWPORT_VRS_TEXTURE].
</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 02:17:47 +00:00
<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 13:28:05 +00: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 02:17:47 +00:00
<description>
classref: Sync with current source
2017-10-21 10:02:08 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="notifier" type="RID" />
<param index="1" name="aabb" type="AABB" />
classref: Sync with current source
2017-10-21 10:02:08 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="notifier" type="RID" />
<param index="1" name="enter_callable" type="Callable" />
<param index="2" name="exit_callable" type="Callable" />
doc: Sync classref with current source
2021-01-04 13:33:44 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="voxel_gi" type="RID" />
<param index="1" name="to_cell_xform" type="Transform3D" />
<param index="2" name="aabb" type="AABB" />
<param index="3" name="octree_size" type="Vector3i" />
<param index="4" name="octree_cells" type="PackedByteArray" />
<param index="5" name="data_cells" type="PackedByteArray" />
<param index="6" name="distance_field" type="PackedByteArray" />
<param index="7" name="level_counts" type="PackedInt32Array" />
classref: Sync with current source
2017-10-21 10:02:08 +00: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 02:17:47 +00: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 13:28:05 +00: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 16:40:24 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="PackedByteArray" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param 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 16:40:24 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="PackedByteArray" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="voxel_gi" type="RID" />
classref: Sync with current source
2017-10-21 10:02:08 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="PackedInt32Array" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param 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 02:17:47 +00: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 13:28:05 +00:00
<return type="PackedByteArray" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="voxel_gi" type="RID" />
Implement ability to render viewports directly to screen
2019-05-08 18:25:34 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="Vector3i" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param 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 02:17:47 +00: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 13:28:05 +00:00
<return type="Transform3D" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="voxel_gi" type="RID" />
classref: Sync with current source
2017-10-21 10:02:08 +00:00
<description>
</description>
</method>
Implement Physical Light Units as an optional setting. This allows light sources to be specified in physical light units in addition to the regular energy multiplier. In order to avoid loss of precision at high values, brightness values are premultiplied by an exposure normalization value. In support of Physical Light Units this PR also renames CameraEffects to CameraAttributes.
2022-07-31 23:20:24 +00:00
<method name="voxel_gi_set_baked_exposure_normalization">
<return type="void" />
<param index="0" name="voxel_gi" type="RID" />
<param index="1" name="baked_exposure" type="float" />
<description>
Used to inform the renderer what exposure normalization value was used while baking the voxel gi. This value will be used and modulated at run time to ensure that the voxel gi maintains a consistent level of exposure even if the scene-wide exposure normalization is changed at run time. For more information see [method camera_attributes_set_exposure].
</description>
</method>
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="voxel_gi" type="RID" />
<param index="1" name="bias" type="float" />
classref: Sync with current source
2017-10-21 10:02:08 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="voxel_gi" type="RID" />
<param index="1" name="range" type="float" />
classref: Sync with current source
2017-10-21 10:02:08 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="voxel_gi" type="RID" />
<param index="1" name="energy" type="float" />
classref: Sync with current source
2017-10-21 10:02:08 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="voxel_gi" type="RID" />
<param index="1" name="enable" type="bool" />
classref: Sync with current source
2017-10-21 10:02:08 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="voxel_gi" type="RID" />
<param index="1" name="bias" type="float" />
classref: Sync with current source
2017-10-21 10:02:08 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="voxel_gi" type="RID" />
<param 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 14:38:26 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param 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 16:40:24 +00: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 02:17:47 +00: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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="voxel_gi" type="RID" />
<param index="1" name="enable" type="bool" />
classref: Sync with current source
2017-10-21 10:02:08 +00: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 20:42:36 +00:00
</methods>
DocData: Skip language-specific ClassDoc without methods/constants Removes the useless `@C#`, `@NativeScript` and `@VisualScript` entries.
2020-06-17 13:06:13 +00: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 19:35:18 +00:00
<signals>
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 09:56:21 +00: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 16:22:57 +00: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 09:56:21 +00:00
</description>
</signal>
<signal name="frame_pre_draw">
doc: Sync classref with current source
2017-11-15 19:35:18 +00: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 16:22:57 +00:00
Emitted at the beginning of the frame, before the RenderingServer updates all the Viewports.
doc: Sync classref with current source
2017-11-15 19:35:18 +00: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 20:42:36 +00:00
<constants>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 22:16:30 +00:00
<constant name="NO_INDEX_ARRAY" value="-1">
Added documentation for VisualServer
2017-11-26 15:37:37 +00:00
Marks an error that shows that the index array is empty.
classref: Sync with current source
2017-10-21 10:02:08 +00:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 22:16:30 +00:00
<constant name="ARRAY_WEIGHTS_SIZE" value="4">
Finish documenting VisualServer
2020-01-05 23:36:50 +00:00
Number of weights/bones per vertex.
classref: Sync with current source
2017-10-21 10:02:08 +00:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 22:16:30 +00:00
<constant name="CANVAS_ITEM_Z_MIN" value="-4096">
Added documentation for VisualServer
2017-11-26 15:37:37 +00:00
The minimum Z-layer for canvas items.
classref: Sync with current source
2017-10-21 10:02:08 +00:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 22:16:30 +00:00
<constant name="CANVAS_ITEM_Z_MAX" value="4096">
Added documentation for VisualServer
2017-11-26 15:37:37 +00:00
The maximum Z-layer for canvas items.
classref: Sync with current source
2017-10-21 10:02:08 +00:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 22:16:30 +00:00
<constant name="MAX_GLOW_LEVELS" value="7">
Finish documenting VisualServer
2020-01-05 23:36:50 +00:00
Max number of glow levels that can be used with glow post-process effect.
classref: Sync with current source
2017-10-21 10:02:08 +00:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 22:16:30 +00:00
<constant name="MAX_CURSORS" value="8">
Finish documenting VisualServer
2020-01-05 23:36:50 +00:00
Unused enum in Godot 3.x.
classref: Sync with current source
2017-10-21 10:02:08 +00: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 02:17:47 +00: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 08:59:06 +00:00
<constant name="TEXTURE_LAYERED_2D_ARRAY" value="0" enum="TextureLayeredType">
classref: Sync with current source
2017-10-21 10:02:08 +00: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 08:59:06 +00:00
<constant name="TEXTURE_LAYERED_CUBEMAP" value="1" enum="TextureLayeredType">
classref: Sync with current source
2017-10-21 10:02:08 +00: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 08:59:06 +00:00
<constant name="TEXTURE_LAYERED_CUBEMAP_ARRAY" value="2" enum="TextureLayeredType">
classref: Sync with current source
2017-10-21 10:02:08 +00: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 08:59:06 +00:00
<constant name="CUBEMAP_LAYER_LEFT" value="0" enum="CubeMapLayer">
classref: Sync with current source
2017-10-21 10:02:08 +00: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 08:59:06 +00:00
<constant name="CUBEMAP_LAYER_RIGHT" value="1" enum="CubeMapLayer">
classref: Sync with current source
2017-10-21 10:02:08 +00: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 08:59:06 +00:00
<constant name="CUBEMAP_LAYER_BOTTOM" value="2" enum="CubeMapLayer">
doc: Sync classref with current source
2018-08-20 22:35:30 +00: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 08:59:06 +00:00
<constant name="CUBEMAP_LAYER_TOP" value="3" enum="CubeMapLayer">
doc: Sync classref with current source
2018-08-20 22:35:30 +00: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 08:59:06 +00:00
<constant name="CUBEMAP_LAYER_FRONT" value="4" enum="CubeMapLayer">
doc: Sync classref with current source
2018-08-20 22:35:30 +00: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 08:59:06 +00:00
<constant name="CUBEMAP_LAYER_BACK" value="5" enum="CubeMapLayer">
classref: Sync with current source
2017-10-21 10:02:08 +00:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 22:16:30 +00:00
<constant name="SHADER_SPATIAL" value="0" enum="ShaderMode">
Added documentation for VisualServer
2017-11-26 15:37:37 +00:00
Shader is a 3D shader.
classref: Sync with current source
2017-10-21 10:02:08 +00:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 22:16:30 +00:00
<constant name="SHADER_CANVAS_ITEM" value="1" enum="ShaderMode">
Added documentation for VisualServer
2017-11-26 15:37:37 +00:00
Shader is a 2D shader.
classref: Sync with current source
2017-10-21 10:02:08 +00:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 22:16:30 +00:00
<constant name="SHADER_PARTICLES" value="2" enum="ShaderMode">
Added documentation for VisualServer
2017-11-26 15:37:37 +00:00
Shader is a particle shader.
classref: Sync with current source
2017-10-21 10:02:08 +00:00
</constant>
Working sky shader implementation
2020-03-20 00:32:19 +00: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 11:28:55 +00: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 09:10:53 +00:00
Represents the size of the [enum ShaderMode] enum.
classref: Sync with current source
2017-10-21 10:02:08 +00:00
</constant>
doc: Sync classref with current source Add missing enum bindings.
2020-04-20 09:48:00 +00: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 22:16:30 +00:00
<constant name="ARRAY_VERTEX" value="0" enum="ArrayType">
Added documentation for VisualServer
2017-11-26 15:37:37 +00:00
Array is a vertex array.
classref: Sync with current source
2017-10-21 10:02:08 +00:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 22:16:30 +00:00
<constant name="ARRAY_NORMAL" value="1" enum="ArrayType">
Added documentation for VisualServer
2017-11-26 15:37:37 +00:00
Array is a normal array.
classref: Sync with current source
2017-10-21 10:02:08 +00:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 22:16:30 +00:00
<constant name="ARRAY_TANGENT" value="2" enum="ArrayType">
Added documentation for VisualServer
2017-11-26 15:37:37 +00:00
Array is a tangent array.
classref: Sync with current source
2017-10-21 10:02:08 +00:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 22:16:30 +00:00
<constant name="ARRAY_COLOR" value="3" enum="ArrayType">
Added documentation for VisualServer
2017-11-26 15:37:37 +00:00
Array is a color array.
classref: Sync with current source
2017-10-21 10:02:08 +00:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 22:16:30 +00: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-21 23:04:47 +00:00
Array is an UV coordinates array.
classref: Sync with current source
2017-10-21 10:02:08 +00:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 22:16:30 +00: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-21 23:04:47 +00:00
Array is an UV coordinates array for the second UV coordinates.
classref: Sync with current source
2017-10-21 10:02:08 +00: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 14:54:48 +00: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 15:37:37 +00:00
Array contains bone information.
classref: Sync with current source
2017-10-21 10:02:08 +00: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 14:54:48 +00:00
<constant name="ARRAY_WEIGHTS" value="11" enum="ArrayType">
Added documentation for VisualServer
2017-11-26 15:37:37 +00:00
Array is weight information.
classref: Sync with current source
2017-10-21 10:02:08 +00: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 14:54:48 +00:00
<constant name="ARRAY_INDEX" value="12" enum="ArrayType">
Added documentation for VisualServer
2017-11-26 15:37:37 +00:00
Array is index array.
classref: Sync with current source
2017-10-21 10:02:08 +00: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 14:54:48 +00:00
<constant name="ARRAY_MAX" value="13" enum="ArrayType">
doc: Complete and harmonize all _MAX constant descriptions
2019-06-27 09:10:53 +00:00
Represents the size of the [enum ArrayType] enum.
classref: Sync with current source
2017-10-21 10:02:08 +00: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 02:17:47 +00: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>
Use BitField<> hint for ArrayFormat This was missing in the conversion of bitflags to BitField<>.
2023-01-07 19:37:21 +00:00
<constant name="ARRAY_FORMAT_VERTEX" value="1" enum="ArrayFormat" is_bitfield="true">
Added documentation for VisualServer
2017-11-26 15:37:37 +00:00
Flag used to mark a vertex array.
classref: Sync with current source
2017-10-21 10:02:08 +00:00
</constant>
Use BitField<> hint for ArrayFormat This was missing in the conversion of bitflags to BitField<>.
2023-01-07 19:37:21 +00:00
<constant name="ARRAY_FORMAT_NORMAL" value="2" enum="ArrayFormat" is_bitfield="true">
Added documentation for VisualServer
2017-11-26 15:37:37 +00:00
Flag used to mark a normal array.
classref: Sync with current source
2017-10-21 10:02:08 +00:00
</constant>
Use BitField<> hint for ArrayFormat This was missing in the conversion of bitflags to BitField<>.
2023-01-07 19:37:21 +00:00
<constant name="ARRAY_FORMAT_TANGENT" value="4" enum="ArrayFormat" is_bitfield="true">
Added documentation for VisualServer
2017-11-26 15:37:37 +00:00
Flag used to mark a tangent array.
classref: Sync with current source
2017-10-21 10:02:08 +00:00
</constant>
Use BitField<> hint for ArrayFormat This was missing in the conversion of bitflags to BitField<>.
2023-01-07 19:37:21 +00:00
<constant name="ARRAY_FORMAT_COLOR" value="8" enum="ArrayFormat" is_bitfield="true">
Added documentation for VisualServer
2017-11-26 15:37:37 +00:00
Flag used to mark a color array.
classref: Sync with current source
2017-10-21 10:02:08 +00:00
</constant>
Use BitField<> hint for ArrayFormat This was missing in the conversion of bitflags to BitField<>.
2023-01-07 19:37:21 +00:00
<constant name="ARRAY_FORMAT_TEX_UV" value="16" enum="ArrayFormat" is_bitfield="true">
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-21 23:04:47 +00:00
Flag used to mark an UV coordinates array.
classref: Sync with current source
2017-10-21 10:02:08 +00:00
</constant>
Use BitField<> hint for ArrayFormat This was missing in the conversion of bitflags to BitField<>.
2023-01-07 19:37:21 +00:00
<constant name="ARRAY_FORMAT_TEX_UV2" value="32" enum="ArrayFormat" is_bitfield="true">
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-21 23:04:47 +00:00
Flag used to mark an UV coordinates array for the second UV coordinates.
classref: Sync with current source
2017-10-21 10:02:08 +00:00
</constant>
Use BitField<> hint for ArrayFormat This was missing in the conversion of bitflags to BitField<>.
2023-01-07 19:37:21 +00:00
<constant name="ARRAY_FORMAT_CUSTOM0" value="64" enum="ArrayFormat" is_bitfield="true">
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 14:54:48 +00:00
</constant>
Use BitField<> hint for ArrayFormat This was missing in the conversion of bitflags to BitField<>.
2023-01-07 19:37:21 +00:00
<constant name="ARRAY_FORMAT_CUSTOM1" value="128" enum="ArrayFormat" is_bitfield="true">
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 14:54:48 +00:00
</constant>
Use BitField<> hint for ArrayFormat This was missing in the conversion of bitflags to BitField<>.
2023-01-07 19:37:21 +00:00
<constant name="ARRAY_FORMAT_CUSTOM2" value="256" enum="ArrayFormat" is_bitfield="true">
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 14:54:48 +00:00
</constant>
Use BitField<> hint for ArrayFormat This was missing in the conversion of bitflags to BitField<>.
2023-01-07 19:37:21 +00:00
<constant name="ARRAY_FORMAT_CUSTOM3" value="512" enum="ArrayFormat" is_bitfield="true">
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 14:54:48 +00:00
</constant>
Use BitField<> hint for ArrayFormat This was missing in the conversion of bitflags to BitField<>.
2023-01-07 19:37:21 +00:00
<constant name="ARRAY_FORMAT_BONES" value="1024" enum="ArrayFormat" is_bitfield="true">
Added documentation for VisualServer
2017-11-26 15:37:37 +00:00
Flag used to mark a bone information array.
classref: Sync with current source
2017-10-21 10:02:08 +00:00
</constant>
Use BitField<> hint for ArrayFormat This was missing in the conversion of bitflags to BitField<>.
2023-01-07 19:37:21 +00:00
<constant name="ARRAY_FORMAT_WEIGHTS" value="2048" enum="ArrayFormat" is_bitfield="true">
Added documentation for VisualServer
2017-11-26 15:37:37 +00:00
Flag used to mark a weights array.
classref: Sync with current source
2017-10-21 10:02:08 +00:00
</constant>
Use BitField<> hint for ArrayFormat This was missing in the conversion of bitflags to BitField<>.
2023-01-07 19:37:21 +00:00
<constant name="ARRAY_FORMAT_INDEX" value="4096" enum="ArrayFormat" is_bitfield="true">
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-21 23:04:47 +00:00
Flag used to mark an index array.
classref: Sync with current source
2017-10-21 10:02:08 +00:00
</constant>
Use BitField<> hint for ArrayFormat This was missing in the conversion of bitflags to BitField<>.
2023-01-07 19:37:21 +00:00
<constant name="ARRAY_FORMAT_BLEND_SHAPE_MASK" value="7" enum="ArrayFormat" is_bitfield="true">
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 14:54:48 +00:00
</constant>
Use BitField<> hint for ArrayFormat This was missing in the conversion of bitflags to BitField<>.
2023-01-07 19:37:21 +00:00
<constant name="ARRAY_FORMAT_CUSTOM_BASE" value="13" enum="ArrayFormat" is_bitfield="true">
classref: Sync with current source
2017-10-21 10:02:08 +00:00
</constant>
Use BitField<> hint for ArrayFormat This was missing in the conversion of bitflags to BitField<>.
2023-01-07 19:37:21 +00:00
<constant name="ARRAY_FORMAT_CUSTOM_BITS" value="3" enum="ArrayFormat" is_bitfield="true">
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 02:17:47 +00:00
</constant>
Use BitField<> hint for ArrayFormat This was missing in the conversion of bitflags to BitField<>.
2023-01-07 19:37:21 +00:00
<constant name="ARRAY_FORMAT_CUSTOM0_SHIFT" value="13" enum="ArrayFormat" is_bitfield="true">
classref: Sync with current source
2017-10-21 10:02:08 +00:00
</constant>
Use BitField<> hint for ArrayFormat This was missing in the conversion of bitflags to BitField<>.
2023-01-07 19:37:21 +00:00
<constant name="ARRAY_FORMAT_CUSTOM1_SHIFT" value="16" enum="ArrayFormat" is_bitfield="true">
classref: Sync with current source
2017-10-21 10:02:08 +00:00
</constant>
Use BitField<> hint for ArrayFormat This was missing in the conversion of bitflags to BitField<>.
2023-01-07 19:37:21 +00:00
<constant name="ARRAY_FORMAT_CUSTOM2_SHIFT" value="19" enum="ArrayFormat" is_bitfield="true">
classref: Sync with current source
2017-10-21 10:02:08 +00:00
</constant>
Use BitField<> hint for ArrayFormat This was missing in the conversion of bitflags to BitField<>.
2023-01-07 19:37:21 +00:00
<constant name="ARRAY_FORMAT_CUSTOM3_SHIFT" value="22" enum="ArrayFormat" is_bitfield="true">
classref: Sync with current source
2017-10-21 10:02:08 +00:00
</constant>
Use BitField<> hint for ArrayFormat This was missing in the conversion of bitflags to BitField<>.
2023-01-07 19:37:21 +00:00
<constant name="ARRAY_FORMAT_CUSTOM_MASK" value="7" enum="ArrayFormat" is_bitfield="true">
classref: Sync with current source
2017-10-21 10:02:08 +00:00
</constant>
Use BitField<> hint for ArrayFormat This was missing in the conversion of bitflags to BitField<>.
2023-01-07 19:37:21 +00:00
<constant name="ARRAY_COMPRESS_FLAGS_BASE" value="25" enum="ArrayFormat" is_bitfield="true">
doc: Sync classref with current source Add missing enum bindings.
2020-04-20 09:48:00 +00:00
</constant>
Use BitField<> hint for ArrayFormat This was missing in the conversion of bitflags to BitField<>.
2023-01-07 19:37:21 +00:00
<constant name="ARRAY_FLAG_USE_2D_VERTICES" value="33554432" enum="ArrayFormat" is_bitfield="true">
Added documentation for VisualServer
2017-11-26 15:37:37 +00:00
Flag used to mark that the array contains 2D vertices.
classref: Sync with current source
2017-10-21 10:02:08 +00:00
</constant>
Use BitField<> hint for ArrayFormat This was missing in the conversion of bitflags to BitField<>.
2023-01-07 19:37:21 +00:00
<constant name="ARRAY_FLAG_USE_DYNAMIC_UPDATE" value="67108864" enum="ArrayFormat" is_bitfield="true">
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 14:54:48 +00:00
</constant>
Use BitField<> hint for ArrayFormat This was missing in the conversion of bitflags to BitField<>.
2023-01-07 19:37:21 +00:00
<constant name="ARRAY_FLAG_USE_8_BONE_WEIGHTS" value="134217728" enum="ArrayFormat" is_bitfield="true">
classref: Sync with current source
2017-10-21 10:02:08 +00:00
</constant>
Fix LOD sort order; checks in add_surface; and document all parameters of `ArrayMesh::add_surface_from_arrays` Also clarify some related documentation and expose the misssing `ArrayFormat::ARRAY_FLAG_USES_EMPTY_VERTEX_ARRAY`
2023-01-17 11:48:10 +00:00
<constant name="ARRAY_FLAG_USES_EMPTY_VERTEX_ARRAY" value="268435456" enum="ArrayFormat" is_bitfield="true">
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 22:16:30 +00:00
<constant name="PRIMITIVE_POINTS" value="0" enum="PrimitiveType">
Added documentation for VisualServer
2017-11-26 15:37:37 +00:00
Primitive to draw consists of points.
classref: Sync with current source
2017-10-21 10:02:08 +00:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 22:16:30 +00:00
<constant name="PRIMITIVE_LINES" value="1" enum="PrimitiveType">
Added documentation for VisualServer
2017-11-26 15:37:37 +00:00
Primitive to draw consists of lines.
classref: Sync with current source
2017-10-21 10:02:08 +00:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 22:16:30 +00:00
<constant name="PRIMITIVE_LINE_STRIP" value="2" enum="PrimitiveType">
Added documentation for VisualServer
2017-11-26 15:37:37 +00:00
Primitive to draw consists of a line strip from start to end.
classref: Sync with current source
2017-10-21 10:02:08 +00: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 08:59:06 +00:00
<constant name="PRIMITIVE_TRIANGLES" value="3" enum="PrimitiveType">
Added documentation for VisualServer
2017-11-26 15:37:37 +00:00
Primitive to draw consists of triangles.
classref: Sync with current source
2017-10-21 10:02:08 +00: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 08:59:06 +00: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 20:37:17 +00: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 10:02:08 +00: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 08:59:06 +00:00
<constant name="PRIMITIVE_MAX" value="5" enum="PrimitiveType">
doc: Complete and harmonize all _MAX constant descriptions
2019-06-27 09:10:53 +00:00
Represents the size of the [enum PrimitiveType] enum.
classref: Sync with current source
2017-10-21 10:02:08 +00:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 22:16:30 +00:00
<constant name="BLEND_SHAPE_MODE_NORMALIZED" value="0" enum="BlendShapeMode">
Finish documenting VisualServer
2020-01-05 23:36:50 +00:00
Blend shapes are normalized.
classref: Sync with current source
2017-10-21 10:02:08 +00:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 22:16:30 +00:00
<constant name="BLEND_SHAPE_MODE_RELATIVE" value="1" enum="BlendShapeMode">
Finish documenting VisualServer
2020-01-05 23:36:50 +00:00
Blend shapes are relative to base weight.
classref: Sync with current source
2017-10-21 10:02:08 +00: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 08:59:06 +00: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 08:27:36 +00: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 08:59:06 +00: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 19:41:55 +00:00
<constant name="LIGHT_PROJECTOR_FILTER_NEAREST" value="0" enum="LightProjectorFilter">
Add Nearest Mipmap Anisotropic filter option to decals and projectors This is consistent with the BaseMaterial3D filtering options. It can be used for high-quality pixel art textures that remain sharp when viewed at oblique angles, but prevents them from becoming grainy thanks to mipmaps.
2021-08-11 22:44:24 +00:00
Nearest-neighbor filter for light projectors (use for pixel art light projectors). No mipmaps are used for rendering, which means light projectors at a distance will look sharp but grainy. This has roughly the same performance cost as using mipmaps.
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 19:41:55 +00:00
</constant>
Add Nearest Mipmap Anisotropic filter option to decals and projectors This is consistent with the BaseMaterial3D filtering options. It can be used for high-quality pixel art textures that remain sharp when viewed at oblique angles, but prevents them from becoming grainy thanks to mipmaps.
2021-08-11 22:44:24 +00:00
<constant name="LIGHT_PROJECTOR_FILTER_LINEAR" value="1" enum="LightProjectorFilter">
Linear filter for light projectors (use for non-pixel art light projectors). No mipmaps are used for rendering, which means light projectors at a distance will look smooth but blurry. This has roughly the same performance cost as using mipmaps.
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 19:41:55 +00:00
</constant>
Add Nearest Mipmap Anisotropic filter option to decals and projectors This is consistent with the BaseMaterial3D filtering options. It can be used for high-quality pixel art textures that remain sharp when viewed at oblique angles, but prevents them from becoming grainy thanks to mipmaps.
2021-08-11 22:44:24 +00:00
<constant name="LIGHT_PROJECTOR_FILTER_NEAREST_MIPMAPS" value="2" enum="LightProjectorFilter">
Nearest-neighbor filter for light projectors (use for pixel art light projectors). Isotropic mipmaps are used for rendering, which means light projectors at a distance will look smooth but blurry. This has roughly the same performance cost as not using mipmaps.
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 19:41:55 +00:00
</constant>
<constant name="LIGHT_PROJECTOR_FILTER_LINEAR_MIPMAPS" value="3" enum="LightProjectorFilter">
Add Nearest Mipmap Anisotropic filter option to decals and projectors This is consistent with the BaseMaterial3D filtering options. It can be used for high-quality pixel art textures that remain sharp when viewed at oblique angles, but prevents them from becoming grainy thanks to mipmaps.
2021-08-11 22:44:24 +00:00
Linear filter for light projectors (use for non-pixel art light projectors). Isotropic mipmaps are used for rendering, which means light projectors at a distance will look smooth but blurry. This has roughly the same performance cost as not using mipmaps.
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 19:41:55 +00:00
</constant>
Add Nearest Mipmap Anisotropic filter option to decals and projectors This is consistent with the BaseMaterial3D filtering options. It can be used for high-quality pixel art textures that remain sharp when viewed at oblique angles, but prevents them from becoming grainy thanks to mipmaps.
2021-08-11 22:44:24 +00:00
<constant name="LIGHT_PROJECTOR_FILTER_NEAREST_MIPMAPS_ANISOTROPIC" value="4" enum="LightProjectorFilter">
Nearest-neighbor filter for light projectors (use for pixel art light projectors). Anisotropic mipmaps are used for rendering, which means light projectors at a distance will look smooth and sharp when viewed from oblique angles. This looks better compared to isotropic mipmaps, but is slower. The level of anisotropic filtering is defined by [member ProjectSettings.rendering/textures/default_filters/anisotropic_filtering_level].
</constant>
<constant name="LIGHT_PROJECTOR_FILTER_LINEAR_MIPMAPS_ANISOTROPIC" value="5" enum="LightProjectorFilter">
Linear filter for light projectors (use for non-pixel art light projectors). Anisotropic mipmaps are used for rendering, which means light projectors at a distance will look smooth and sharp when viewed from oblique angles. This looks better compared to isotropic mipmaps, but is slower. The level of anisotropic filtering is defined by [member ProjectSettings.rendering/textures/default_filters/anisotropic_filtering_level].
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 19:41:55 +00:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 22:16:30 +00:00
<constant name="LIGHT_DIRECTIONAL" value="0" enum="LightType">
Added documentation for VisualServer
2017-11-26 15:37:37 +00:00
Is a directional (sun) light.
classref: Sync with current source
2017-10-21 10:02:08 +00:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 22:16:30 +00: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-21 23:04:47 +00:00
Is an omni light.
classref: Sync with current source
2017-10-21 10:02:08 +00:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 22:16:30 +00: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-21 23:04:47 +00:00
Is a spot light.
classref: Sync with current source
2017-10-21 10:02:08 +00:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 22:16:30 +00:00
<constant name="LIGHT_PARAM_ENERGY" value="0" enum="LightParam">
Add a per-light volumetric fog energy property Per-light energy gives more control to the user on the final result of volumetric fog. Specific lights can be fully excluded from volumetric fog by setting their volumetric fog energy to 0, which improves performance slightly. This can also be used to prevent short-lived dynamic effects from poorly interacting with volumetric fog, as it's updated over several frames by default unless temporal reprojection is disabled. Volumetric fog shadows now obey Light3D's Shadow Opacity property as well. The shadow fog fade property was removed as it had little visible impact on the final scene's rendering.
2021-07-09 08:28:33 +00:00
The light's energy multiplier.
classref: Sync with current source
2017-10-21 10:02:08 +00: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 08:59:06 +00:00
<constant name="LIGHT_PARAM_INDIRECT_ENERGY" value="1" enum="LightParam">
Add a shadow opacity property to Light3D This can be used to make shadows translucent for a specific light. The light distance fade system also uses this to smoothly fade the shadow when the light fade transition distance is greater than 0.
2022-06-10 10:47:06 +00:00
The light's indirect energy multiplier (final indirect energy is [constant LIGHT_PARAM_ENERGY] * [constant LIGHT_PARAM_INDIRECT_ENERGY]).
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 08:59:06 +00:00
</constant>
Add a per-light volumetric fog energy property Per-light energy gives more control to the user on the final result of volumetric fog. Specific lights can be fully excluded from volumetric fog by setting their volumetric fog energy to 0, which improves performance slightly. This can also be used to prevent short-lived dynamic effects from poorly interacting with volumetric fog, as it's updated over several frames by default unless temporal reprojection is disabled. Volumetric fog shadows now obey Light3D's Shadow Opacity property as well. The shadow fog fade property was removed as it had little visible impact on the final scene's rendering.
2021-07-09 08:28:33 +00:00
<constant name="LIGHT_PARAM_VOLUMETRIC_FOG_ENERGY" value="2" enum="LightParam">
The light's volumetric fog energy multiplier (final volumetric fog energy is [constant LIGHT_PARAM_ENERGY] * [constant LIGHT_PARAM_VOLUMETRIC_FOG_ENERGY]).
</constant>
<constant name="LIGHT_PARAM_SPECULAR" value="3" enum="LightParam">
Added documentation for VisualServer
2017-11-26 15:37:37 +00:00
The light's influence on specularity.
classref: Sync with current source
2017-10-21 10:02:08 +00:00
</constant>
Add a per-light volumetric fog energy property Per-light energy gives more control to the user on the final result of volumetric fog. Specific lights can be fully excluded from volumetric fog by setting their volumetric fog energy to 0, which improves performance slightly. This can also be used to prevent short-lived dynamic effects from poorly interacting with volumetric fog, as it's updated over several frames by default unless temporal reprojection is disabled. Volumetric fog shadows now obey Light3D's Shadow Opacity property as well. The shadow fog fade property was removed as it had little visible impact on the final scene's rendering.
2021-07-09 08:28:33 +00:00
<constant name="LIGHT_PARAM_RANGE" value="4" enum="LightParam">
Added documentation for VisualServer
2017-11-26 15:37:37 +00:00
The light's range.
classref: Sync with current source
2017-10-21 10:02:08 +00:00
</constant>
Add a per-light volumetric fog energy property Per-light energy gives more control to the user on the final result of volumetric fog. Specific lights can be fully excluded from volumetric fog by setting their volumetric fog energy to 0, which improves performance slightly. This can also be used to prevent short-lived dynamic effects from poorly interacting with volumetric fog, as it's updated over several frames by default unless temporal reprojection is disabled. Volumetric fog shadows now obey Light3D's Shadow Opacity property as well. The shadow fog fade property was removed as it had little visible impact on the final scene's rendering.
2021-07-09 08:28:33 +00:00
<constant name="LIGHT_PARAM_SIZE" value="5" enum="LightParam">
Add proper quality settings to soft shadows
2020-04-10 09:30:36 +00:00
The size of the light when using spot light or omni light. The angular size of the light when using directional light.
</constant>
Add a per-light volumetric fog energy property Per-light energy gives more control to the user on the final result of volumetric fog. Specific lights can be fully excluded from volumetric fog by setting their volumetric fog energy to 0, which improves performance slightly. This can also be used to prevent short-lived dynamic effects from poorly interacting with volumetric fog, as it's updated over several frames by default unless temporal reprojection is disabled. Volumetric fog shadows now obey Light3D's Shadow Opacity property as well. The shadow fog fade property was removed as it had little visible impact on the final scene's rendering.
2021-07-09 08:28:33 +00:00
<constant name="LIGHT_PARAM_ATTENUATION" value="6" enum="LightParam">
Added documentation for VisualServer
2017-11-26 15:37:37 +00:00
The light's attenuation.
classref: Sync with current source
2017-10-21 10:02:08 +00:00
</constant>
Add a per-light volumetric fog energy property Per-light energy gives more control to the user on the final result of volumetric fog. Specific lights can be fully excluded from volumetric fog by setting their volumetric fog energy to 0, which improves performance slightly. This can also be used to prevent short-lived dynamic effects from poorly interacting with volumetric fog, as it's updated over several frames by default unless temporal reprojection is disabled. Volumetric fog shadows now obey Light3D's Shadow Opacity property as well. The shadow fog fade property was removed as it had little visible impact on the final scene's rendering.
2021-07-09 08:28:33 +00:00
<constant name="LIGHT_PARAM_SPOT_ANGLE" value="7" enum="LightParam">
Added documentation for VisualServer
2017-11-26 15:37:37 +00:00
The spotlight's angle.
classref: Sync with current source
2017-10-21 10:02:08 +00:00
</constant>
Add a per-light volumetric fog energy property Per-light energy gives more control to the user on the final result of volumetric fog. Specific lights can be fully excluded from volumetric fog by setting their volumetric fog energy to 0, which improves performance slightly. This can also be used to prevent short-lived dynamic effects from poorly interacting with volumetric fog, as it's updated over several frames by default unless temporal reprojection is disabled. Volumetric fog shadows now obey Light3D's Shadow Opacity property as well. The shadow fog fade property was removed as it had little visible impact on the final scene's rendering.
2021-07-09 08:28:33 +00:00
<constant name="LIGHT_PARAM_SPOT_ATTENUATION" value="8" enum="LightParam">
Added documentation for VisualServer
2017-11-26 15:37:37 +00:00
The spotlight's attenuation.
classref: Sync with current source
2017-10-21 10:02:08 +00:00
</constant>
Add a per-light volumetric fog energy property Per-light energy gives more control to the user on the final result of volumetric fog. Specific lights can be fully excluded from volumetric fog by setting their volumetric fog energy to 0, which improves performance slightly. This can also be used to prevent short-lived dynamic effects from poorly interacting with volumetric fog, as it's updated over several frames by default unless temporal reprojection is disabled. Volumetric fog shadows now obey Light3D's Shadow Opacity property as well. The shadow fog fade property was removed as it had little visible impact on the final scene's rendering.
2021-07-09 08:28:33 +00:00
<constant name="LIGHT_PARAM_SHADOW_MAX_DISTANCE" value="9" enum="LightParam">
Finish documenting VisualServer
2020-01-05 23:36:50 +00:00
Max distance that shadows will be rendered.
classref: Sync with current source
2017-10-21 10:02:08 +00:00
</constant>
Add a per-light volumetric fog energy property Per-light energy gives more control to the user on the final result of volumetric fog. Specific lights can be fully excluded from volumetric fog by setting their volumetric fog energy to 0, which improves performance slightly. This can also be used to prevent short-lived dynamic effects from poorly interacting with volumetric fog, as it's updated over several frames by default unless temporal reprojection is disabled. Volumetric fog shadows now obey Light3D's Shadow Opacity property as well. The shadow fog fade property was removed as it had little visible impact on the final scene's rendering.
2021-07-09 08:28:33 +00:00
<constant name="LIGHT_PARAM_SHADOW_SPLIT_1_OFFSET" value="10" enum="LightParam">
Finish documenting VisualServer
2020-01-05 23:36:50 +00:00
Proportion of shadow atlas occupied by the first split.
classref: Sync with current source
2017-10-21 10:02:08 +00:00
</constant>
Add a per-light volumetric fog energy property Per-light energy gives more control to the user on the final result of volumetric fog. Specific lights can be fully excluded from volumetric fog by setting their volumetric fog energy to 0, which improves performance slightly. This can also be used to prevent short-lived dynamic effects from poorly interacting with volumetric fog, as it's updated over several frames by default unless temporal reprojection is disabled. Volumetric fog shadows now obey Light3D's Shadow Opacity property as well. The shadow fog fade property was removed as it had little visible impact on the final scene's rendering.
2021-07-09 08:28:33 +00:00
<constant name="LIGHT_PARAM_SHADOW_SPLIT_2_OFFSET" value="11" enum="LightParam">
Finish documenting VisualServer
2020-01-05 23:36:50 +00:00
Proportion of shadow atlas occupied by the second split.
classref: Sync with current source
2017-10-21 10:02:08 +00:00
</constant>
Add a per-light volumetric fog energy property Per-light energy gives more control to the user on the final result of volumetric fog. Specific lights can be fully excluded from volumetric fog by setting their volumetric fog energy to 0, which improves performance slightly. This can also be used to prevent short-lived dynamic effects from poorly interacting with volumetric fog, as it's updated over several frames by default unless temporal reprojection is disabled. Volumetric fog shadows now obey Light3D's Shadow Opacity property as well. The shadow fog fade property was removed as it had little visible impact on the final scene's rendering.
2021-07-09 08:28:33 +00:00
<constant name="LIGHT_PARAM_SHADOW_SPLIT_3_OFFSET" value="12" enum="LightParam">
Finish documenting VisualServer
2020-01-05 23:36:50 +00:00
Proportion of shadow atlas occupied by the third split. The fourth split occupies the rest.
classref: Sync with current source
2017-10-21 10:02:08 +00:00
</constant>
Add a per-light volumetric fog energy property Per-light energy gives more control to the user on the final result of volumetric fog. Specific lights can be fully excluded from volumetric fog by setting their volumetric fog energy to 0, which improves performance slightly. This can also be used to prevent short-lived dynamic effects from poorly interacting with volumetric fog, as it's updated over several frames by default unless temporal reprojection is disabled. Volumetric fog shadows now obey Light3D's Shadow Opacity property as well. The shadow fog fade property was removed as it had little visible impact on the final scene's rendering.
2021-07-09 08:28:33 +00:00
<constant name="LIGHT_PARAM_SHADOW_FADE_START" value="13" enum="LightParam">
Update many docs with recent rendering changes
2020-04-16 23:05:25 +00: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 08:59:06 +00:00
</constant>
Add a per-light volumetric fog energy property Per-light energy gives more control to the user on the final result of volumetric fog. Specific lights can be fully excluded from volumetric fog by setting their volumetric fog energy to 0, which improves performance slightly. This can also be used to prevent short-lived dynamic effects from poorly interacting with volumetric fog, as it's updated over several frames by default unless temporal reprojection is disabled. Volumetric fog shadows now obey Light3D's Shadow Opacity property as well. The shadow fog fade property was removed as it had little visible impact on the final scene's rendering.
2021-07-09 08:28:33 +00:00
<constant name="LIGHT_PARAM_SHADOW_NORMAL_BIAS" value="14" enum="LightParam">
Finish documenting VisualServer
2020-01-05 23:36:50 +00: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 10:02:08 +00:00
</constant>
Add a per-light volumetric fog energy property Per-light energy gives more control to the user on the final result of volumetric fog. Specific lights can be fully excluded from volumetric fog by setting their volumetric fog energy to 0, which improves performance slightly. This can also be used to prevent short-lived dynamic effects from poorly interacting with volumetric fog, as it's updated over several frames by default unless temporal reprojection is disabled. Volumetric fog shadows now obey Light3D's Shadow Opacity property as well. The shadow fog fade property was removed as it had little visible impact on the final scene's rendering.
2021-07-09 08:28:33 +00:00
<constant name="LIGHT_PARAM_SHADOW_BIAS" value="15" enum="LightParam">
Finish documenting VisualServer
2020-01-05 23:36:50 +00:00
Bias the shadow lookup to fix self-shadowing artifacts.
classref: Sync with current source
2017-10-21 10:02:08 +00:00
</constant>
Add a per-light volumetric fog energy property Per-light energy gives more control to the user on the final result of volumetric fog. Specific lights can be fully excluded from volumetric fog by setting their volumetric fog energy to 0, which improves performance slightly. This can also be used to prevent short-lived dynamic effects from poorly interacting with volumetric fog, as it's updated over several frames by default unless temporal reprojection is disabled. Volumetric fog shadows now obey Light3D's Shadow Opacity property as well. The shadow fog fade property was removed as it had little visible impact on the final scene's rendering.
2021-07-09 08:28:33 +00:00
<constant name="LIGHT_PARAM_SHADOW_PANCAKE_SIZE" value="16" enum="LightParam">
Update many docs with recent rendering changes
2020-04-16 23:05:25 +00:00
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 10:02:08 +00:00
</constant>
Add a per-light volumetric fog energy property Per-light energy gives more control to the user on the final result of volumetric fog. Specific lights can be fully excluded from volumetric fog by setting their volumetric fog energy to 0, which improves performance slightly. This can also be used to prevent short-lived dynamic effects from poorly interacting with volumetric fog, as it's updated over several frames by default unless temporal reprojection is disabled. Volumetric fog shadows now obey Light3D's Shadow Opacity property as well. The shadow fog fade property was removed as it had little visible impact on the final scene's rendering.
2021-07-09 08:28:33 +00:00
<constant name="LIGHT_PARAM_SHADOW_OPACITY" value="17" enum="LightParam">
Add a shadow opacity property to Light3D This can be used to make shadows translucent for a specific light. The light distance fade system also uses this to smoothly fade the shadow when the light fade transition distance is greater than 0.
2022-06-10 10:47:06 +00:00
The light's shadow opacity. Values lower than [code]1.0[/code] make the light appear through shadows. This can be used to fake global illumination at a low performance cost.
</constant>
Add a per-light volumetric fog energy property Per-light energy gives more control to the user on the final result of volumetric fog. Specific lights can be fully excluded from volumetric fog by setting their volumetric fog energy to 0, which improves performance slightly. This can also be used to prevent short-lived dynamic effects from poorly interacting with volumetric fog, as it's updated over several frames by default unless temporal reprojection is disabled. Volumetric fog shadows now obey Light3D's Shadow Opacity property as well. The shadow fog fade property was removed as it had little visible impact on the final scene's rendering.
2021-07-09 08:28:33 +00:00
<constant name="LIGHT_PARAM_SHADOW_BLUR" value="18" enum="LightParam">
Update many docs with recent rendering changes
2020-04-16 23:05:25 +00:00
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>
Add a shadow opacity property to Light3D This can be used to make shadows translucent for a specific light. The light distance fade system also uses this to smoothly fade the shadow when the light fade transition distance is greater than 0.
2022-06-10 10:47:06 +00:00
<constant name="LIGHT_PARAM_TRANSMITTANCE_BIAS" value="19" enum="LightParam">
Update many docs with recent rendering changes
2020-04-16 23:05:25 +00:00
</constant>
Implement Physical Light Units as an optional setting. This allows light sources to be specified in physical light units in addition to the regular energy multiplier. In order to avoid loss of precision at high values, brightness values are premultiplied by an exposure normalization value. In support of Physical Light Units this PR also renames CameraEffects to CameraAttributes.
2022-07-31 23:20:24 +00:00
<constant name="LIGHT_PARAM_MAX" value="21" enum="LightParam">
doc: Complete and harmonize all _MAX constant descriptions
2019-06-27 09:10:53 +00:00
Represents the size of the [enum LightParam] enum.
classref: Sync with current source
2017-10-21 10:02:08 +00: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 12:18:13 +00:00
<constant name="LIGHT_BAKE_DISABLED" value="0" enum="LightBakeMode">
</constant>
Rename and reorder bake mode properties for consistency The order now goes from least to most computationally expensive: - Disabled - Static - Dynamic
2021-11-26 16:47:37 +00:00
<constant name="LIGHT_BAKE_STATIC" value="1" enum="LightBakeMode">
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 12:18:13 +00:00
</constant>
Rename and reorder bake mode properties for consistency The order now goes from least to most computationally expensive: - Disabled - Static - Dynamic
2021-11-26 16:47:37 +00:00
<constant name="LIGHT_BAKE_DYNAMIC" value="2" enum="LightBakeMode">
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 12:18:13 +00:00
</constant>
doc: Sync classref with current source
2018-02-19 09:47:16 +00:00
<constant name="LIGHT_OMNI_SHADOW_DUAL_PARABOLOID" value="0" enum="LightOmniShadowMode">
Finish documenting VisualServer
2020-01-05 23:36:50 +00:00
Use a dual paraboloid shadow map for omni lights.
doc: Sync classref with current source
2018-02-19 09:47:16 +00:00
</constant>
<constant name="LIGHT_OMNI_SHADOW_CUBE" value="1" enum="LightOmniShadowMode">
Finish documenting VisualServer
2020-01-05 23:36:50 +00: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 09:47:16 +00:00
</constant>
<constant name="LIGHT_DIRECTIONAL_SHADOW_ORTHOGONAL" value="0" enum="LightDirectionalShadowMode">
Finish documenting VisualServer
2020-01-05 23:36:50 +00:00
Use orthogonal shadow projection for directional light.
doc: Sync classref with current source
2018-02-19 09:47:16 +00:00
</constant>
<constant name="LIGHT_DIRECTIONAL_SHADOW_PARALLEL_2_SPLITS" value="1" enum="LightDirectionalShadowMode">
Finish documenting VisualServer
2020-01-05 23:36:50 +00:00
Use 2 splits for shadow projection when using directional light.
doc: Sync classref with current source
2018-02-19 09:47:16 +00:00
</constant>
<constant name="LIGHT_DIRECTIONAL_SHADOW_PARALLEL_4_SPLITS" value="2" enum="LightDirectionalShadowMode">
Finish documenting VisualServer
2020-01-05 23:36:50 +00:00
Use 4 splits for shadow projection when using directional light.
doc: Sync classref with current source
2018-02-19 09:47:16 +00:00
</constant>
Replace DirectionalLight3D's `use_in_sky_only` with `sky_mode` enum 3 options are available: - Light and Sky (default) - Light Only (new) - Sky Only (equivalent to `use_in_sky_only = true`) Co-authored by: clayjohn <claynjohn@gmail.com>
2021-10-19 22:40:46 +00:00
<constant name="LIGHT_DIRECTIONAL_SKY_MODE_LIGHT_AND_SKY" value="0" enum="LightDirectionalSkyMode">
Use DirectionalLight3D in both sky rendering and scene lighting.
</constant>
<constant name="LIGHT_DIRECTIONAL_SKY_MODE_LIGHT_ONLY" value="1" enum="LightDirectionalSkyMode">
Only use DirectionalLight3D in scene lighting.
</constant>
<constant name="LIGHT_DIRECTIONAL_SKY_MODE_SKY_ONLY" value="2" enum="LightDirectionalSkyMode">
Only use DirectionalLight3D in sky rendering.
</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 02:17:47 +00: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 14:52:57 +00: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 02:17:47 +00: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 14:52:57 +00: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 02:17:47 +00: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 14:52:57 +00: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 02:17:47 +00: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 14:52:57 +00: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 02:17:47 +00: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 14:52:57 +00: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 02:17:47 +00: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 14:52:57 +00: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 02:17:47 +00: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 08:59:06 +00: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 12:18:13 +00: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 09:48:00 +00: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 19:41:55 +00:00
<constant name="DECAL_FILTER_NEAREST" value="0" enum="DecalFilter">
Add Nearest Mipmap Anisotropic filter option to decals and projectors This is consistent with the BaseMaterial3D filtering options. It can be used for high-quality pixel art textures that remain sharp when viewed at oblique angles, but prevents them from becoming grainy thanks to mipmaps.
2021-08-11 22:44:24 +00:00
Nearest-neighbor filter for decals (use for pixel art decals). No mipmaps are used for rendering, which means decals at a distance will look sharp but grainy. This has roughly the same performance cost as using mipmaps.
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 19:41:55 +00:00
</constant>
Add Nearest Mipmap Anisotropic filter option to decals and projectors This is consistent with the BaseMaterial3D filtering options. It can be used for high-quality pixel art textures that remain sharp when viewed at oblique angles, but prevents them from becoming grainy thanks to mipmaps.
2021-08-11 22:44:24 +00:00
<constant name="DECAL_FILTER_LINEAR" value="1" enum="DecalFilter">
Linear filter for decals (use for non-pixel art decals). No mipmaps are used for rendering, which means decals at a distance will look smooth but blurry. This has roughly the same performance cost as using mipmaps.
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 19:41:55 +00:00
</constant>
Add Nearest Mipmap Anisotropic filter option to decals and projectors This is consistent with the BaseMaterial3D filtering options. It can be used for high-quality pixel art textures that remain sharp when viewed at oblique angles, but prevents them from becoming grainy thanks to mipmaps.
2021-08-11 22:44:24 +00:00
<constant name="DECAL_FILTER_NEAREST_MIPMAPS" value="2" enum="DecalFilter">
Nearest-neighbor filter for decals (use for pixel art decals). Isotropic mipmaps are used for rendering, which means decals at a distance will look smooth but blurry. This has roughly the same performance cost as not using mipmaps.
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 19:41:55 +00:00
</constant>
<constant name="DECAL_FILTER_LINEAR_MIPMAPS" value="3" enum="DecalFilter">
Add Nearest Mipmap Anisotropic filter option to decals and projectors This is consistent with the BaseMaterial3D filtering options. It can be used for high-quality pixel art textures that remain sharp when viewed at oblique angles, but prevents them from becoming grainy thanks to mipmaps.
2021-08-11 22:44:24 +00:00
Linear filter for decals (use for non-pixel art decals). Isotropic mipmaps are used for rendering, which means decals at a distance will look smooth but blurry. This has roughly the same performance cost as not using mipmaps.
</constant>
<constant name="DECAL_FILTER_NEAREST_MIPMAPS_ANISOTROPIC" value="4" enum="DecalFilter">
Nearest-neighbor filter for decals (use for pixel art decals). Anisotropic mipmaps are used for rendering, which means decals at a distance will look smooth and sharp when viewed from oblique angles. This looks better compared to isotropic mipmaps, but is slower. The level of anisotropic filtering is defined by [member ProjectSettings.rendering/textures/default_filters/anisotropic_filtering_level].
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 19:41:55 +00:00
</constant>
Add Nearest Mipmap Anisotropic filter option to decals and projectors This is consistent with the BaseMaterial3D filtering options. It can be used for high-quality pixel art textures that remain sharp when viewed at oblique angles, but prevents them from becoming grainy thanks to mipmaps.
2021-08-11 22:44:24 +00:00
<constant name="DECAL_FILTER_LINEAR_MIPMAPS_ANISOTROPIC" value="5" enum="DecalFilter">
Linear filter for decals (use for non-pixel art decals). Anisotropic mipmaps are used for rendering, which means decals at a distance will look smooth and sharp when viewed from oblique angles. This looks better compared to isotropic mipmaps, but is slower. The level of anisotropic filtering is defined by [member ProjectSettings.rendering/textures/default_filters/anisotropic_filtering_level].
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 19:41:55 +00: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 02:17:47 +00: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 08:59:06 +00: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 02:17:47 +00: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 14:25:06 +00: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 08:59:06 +00: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 02:17:47 +00: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 11:28:55 +00:00
<constant name="FOG_VOLUME_SHAPE_ELLIPSOID" value="0" enum="FogVolumeShape">
Add Cone and Cylinder shapes to FogVolume This complements the existing Ellipsoid and Box local fog shapes. This can be used to represent a light cone coming from a SpotLight.
2022-05-21 10:17:49 +00:00
[FogVolume] will be shaped like an ellipsoid (stretched sphere).
Addition of FogVolumes, FogShaders, FogMaterial, and overhaul of VolumetricFog Co-authored-by: Brian Semrau <brian.semrau@gmail.com>
2021-10-03 11:28:55 +00:00
</constant>
Add Cone and Cylinder shapes to FogVolume This complements the existing Ellipsoid and Box local fog shapes. This can be used to represent a light cone coming from a SpotLight.
2022-05-21 10:17:49 +00:00
<constant name="FOG_VOLUME_SHAPE_CONE" value="1" enum="FogVolumeShape">
[FogVolume] will be shaped like a cone pointing upwards (in local coordinates). The cone's angle is set automatically to fill the extents. The cone will be adjusted to fit within the extents. Rotate the [FogVolume] node to reorient the cone. Non-uniform scaling via extents is not supported (scale the [FogVolume] node instead).
</constant>
<constant name="FOG_VOLUME_SHAPE_CYLINDER" value="2" enum="FogVolumeShape">
[FogVolume] will be shaped like an upright cylinder (in local coordinates). Rotate the [FogVolume] node to reorient the cylinder. The cylinder will be adjusted to fit within the extents. Non-uniform scaling via extents is not supported (scale the [FogVolume] node instead).
</constant>
<constant name="FOG_VOLUME_SHAPE_BOX" value="3" enum="FogVolumeShape">
Addition of FogVolumes, FogShaders, FogMaterial, and overhaul of VolumetricFog Co-authored-by: Brian Semrau <brian.semrau@gmail.com>
2021-10-03 11:28:55 +00:00
[FogVolume] will be shaped like a box.
</constant>
Add Cone and Cylinder shapes to FogVolume This complements the existing Ellipsoid and Box local fog shapes. This can be used to represent a light cone coming from a SpotLight.
2022-05-21 10:17:49 +00:00
<constant name="FOG_VOLUME_SHAPE_WORLD" value="4" enum="FogVolumeShape">
Addition of FogVolumes, FogShaders, FogMaterial, and overhaul of VolumetricFog Co-authored-by: Brian Semrau <brian.semrau@gmail.com>
2021-10-03 11:28:55 +00:00
[FogVolume] will have no shape, will cover the whole world and will not be culled.
</constant>
Add Cone and Cylinder shapes to FogVolume This complements the existing Ellipsoid and Box local fog shapes. This can be used to represent a light cone coming from a SpotLight.
2022-05-21 10:17:49 +00:00
<constant name="FOG_VOLUME_SHAPE_MAX" value="5" enum="FogVolumeShape">
</constant>
Implemented AMD's FSR as a computer shader for upscaling 3D scenes
2021-11-23 21:16:03 +00:00
<constant name="VIEWPORT_SCALING_3D_MODE_BILINEAR" value="0" enum="ViewportScaling3DMode">
Fix 3D scaling enum size in the editor and improve descriptions
2022-04-09 15:52:38 +00:00
Use bilinear scaling for the viewport's 3D buffer. The amount of scaling can be set using [member Viewport.scaling_3d_scale]. Values less then [code]1.0[/code] will result in undersampling while values greater than [code]1.0[/code] will result in supersampling. A value of [code]1.0[/code] disables scaling.
Implemented AMD's FSR as a computer shader for upscaling 3D scenes
2021-11-23 21:16:03 +00:00
</constant>
<constant name="VIEWPORT_SCALING_3D_MODE_FSR" value="1" enum="ViewportScaling3DMode">
Fix 3D scaling enum size in the editor and improve descriptions
2022-04-09 15:52:38 +00:00
Use AMD FidelityFX Super Resolution 1.0 upscaling for the viewport's 3D buffer. The amount of scaling can be set using [member Viewport.scaling_3d_scale]. Values less then [code]1.0[/code] will be result in the viewport being upscaled using FSR. Values greater than [code]1.0[/code] are not supported and bilinear downsampling will be used instead. A value of [code]1.0[/code] disables scaling.
Implemented AMD's FSR as a computer shader for upscaling 3D scenes
2021-11-23 21:16:03 +00:00
</constant>
<constant name="VIEWPORT_SCALING_3D_MODE_MAX" value="2" enum="ViewportScaling3DMode">
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 22:16:30 +00:00
<constant name="VIEWPORT_UPDATE_DISABLED" value="0" enum="ViewportUpdateMode">
Finish documenting VisualServer
2020-01-05 23:36:50 +00:00
Do not update the viewport.
classref: Sync with current source
2017-10-21 10:02:08 +00:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 22:16:30 +00:00
<constant name="VIEWPORT_UPDATE_ONCE" value="1" enum="ViewportUpdateMode">
Finish documenting VisualServer
2020-01-05 23:36:50 +00:00
Update the viewport once then set to disabled.
classref: Sync with current source
2017-10-21 10:02:08 +00:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 22:16:30 +00:00
<constant name="VIEWPORT_UPDATE_WHEN_VISIBLE" value="2" enum="ViewportUpdateMode">
Finish documenting VisualServer
2020-01-05 23:36:50 +00:00
Update the viewport whenever it is visible.
classref: Sync with current source
2017-10-21 10:02:08 +00:00
</constant>
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00: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-05 23:36:50 +00:00
Always update the viewport.
classref: Sync with current source
2017-10-21 10:02:08 +00:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 22:16:30 +00:00
<constant name="VIEWPORT_CLEAR_ALWAYS" value="0" enum="ViewportClearMode">
Added documentation for VisualServer
2017-11-26 15:37:37 +00:00
The viewport is always cleared before drawing.
classref: Sync with current source
2017-10-21 10:02:08 +00:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 22:16:30 +00:00
<constant name="VIEWPORT_CLEAR_NEVER" value="1" enum="ViewportClearMode">
Added documentation for VisualServer
2017-11-26 15:37:37 +00:00
The viewport is never cleared before drawing.
classref: Sync with current source
2017-10-21 10:02:08 +00:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 22:16:30 +00: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 10:34:26 +00: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 10:02:08 +00: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 02:17:47 +00: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 22:16:30 +00: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 14:25:10 +00: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 10:02:08 +00:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 22:16:30 +00: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 14:25:10 +00: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 10:02:08 +00:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 22:16:30 +00: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 14:25:10 +00: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 10:02:08 +00:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 22:16:30 +00: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 14:25:10 +00: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 10:02:08 +00: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 14:25:10 +00:00
<constant name="VIEWPORT_MSAA_MAX" value="4" enum="ViewportMSAA">
doc: Sync classref with current source Add missing enum bindings.
2020-04-20 09:48:00 +00: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 02:17:47 +00: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 22:16:30 +00:00
<constant name="VIEWPORT_RENDER_INFO_OBJECTS_IN_FRAME" value="0" enum="ViewportRenderInfo">
Finish documenting VisualServer
2020-01-05 23:36:50 +00:00
Number of objects drawn in a single frame.
classref: Sync with current source
2017-10-21 10:02:08 +00: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-02 23:14:19 +00:00
<constant name="VIEWPORT_RENDER_INFO_PRIMITIVES_IN_FRAME" value="1" enum="ViewportRenderInfo">
Finish documenting VisualServer
2020-01-05 23:36:50 +00:00
Number of vertices drawn in a single frame.
classref: Sync with current source
2017-10-21 10:02:08 +00: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-02 23:14:19 +00: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 10:02:08 +00: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-02 23:14:19 +00: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 10:02:08 +00: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-02 23:14:19 +00:00
<constant name="VIEWPORT_RENDER_INFO_TYPE_VISIBLE" value="0" enum="ViewportRenderInfoType">
classref: Sync with current source
2017-10-21 10:02:08 +00: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-02 23:14:19 +00:00
<constant name="VIEWPORT_RENDER_INFO_TYPE_SHADOW" value="1" enum="ViewportRenderInfoType">
classref: Sync with current source
2017-10-21 10:02:08 +00: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-02 23:14:19 +00:00
<constant name="VIEWPORT_RENDER_INFO_TYPE_MAX" value="2" enum="ViewportRenderInfoType">
classref: Sync with current source
2017-10-21 10:02:08 +00:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 22:16:30 +00:00
<constant name="VIEWPORT_DEBUG_DRAW_DISABLED" value="0" enum="ViewportDebugDraw">
Added documentation for VisualServer
2017-11-26 15:37:37 +00:00
Debug draw is disabled. Default setting.
classref: Sync with current source
2017-10-21 10:02:08 +00:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 22:16:30 +00:00
<constant name="VIEWPORT_DEBUG_DRAW_UNSHADED" value="1" enum="ViewportDebugDraw">
Update many docs with recent rendering changes
2020-04-16 23:05:25 +00:00
Objects are displayed without light information.
classref: Sync with current source
2017-10-21 10:02:08 +00: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 08:59:06 +00:00
<constant name="VIEWPORT_DEBUG_DRAW_LIGHTING" value="2" enum="ViewportDebugDraw">
Update many docs with recent rendering changes
2020-04-16 23:05:25 +00: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 08:59:06 +00: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 15:28:00 +00: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 10:02:08 +00: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 08:59:06 +00:00
<constant name="VIEWPORT_DEBUG_DRAW_WIREFRAME" value="4" enum="ViewportDebugDraw">
Added documentation for VisualServer
2017-11-26 15:37:37 +00:00
Debug draw draws objects in wireframe.
classref: Sync with current source
2017-10-21 10:02:08 +00: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 08:59:06 +00:00
<constant name="VIEWPORT_DEBUG_DRAW_NORMAL_BUFFER" value="5" enum="ViewportDebugDraw">
Update many docs with recent rendering changes
2020-04-16 23:05:25 +00: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 08:59:06 +00: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-04 22:47:26 +00: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 08:59:06 +00: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-04 22:47:26 +00: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 08:59:06 +00: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-04 22:47:26 +00: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 08:59:06 +00:00
</constant>
<constant name="VIEWPORT_DEBUG_DRAW_SHADOW_ATLAS" value="9" enum="ViewportDebugDraw">
Update many docs with recent rendering changes
2020-04-16 23:05:25 +00: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 08:59:06 +00:00
</constant>
<constant name="VIEWPORT_DEBUG_DRAW_DIRECTIONAL_SHADOW_ATLAS" value="10" enum="ViewportDebugDraw">
Update many docs with recent rendering changes
2020-04-16 23:05:25 +00: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 08:59:06 +00: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-16 23:05:25 +00: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 08:59:06 +00:00
</constant>
Added SSIL post processing effect
2021-08-03 07:07:32 +00:00
<constant name="VIEWPORT_DEBUG_DRAW_SSIL" value="13" enum="ViewportDebugDraw">
Draws the screen space indirect lighting texture instead of the scene so that you can clearly see how it is affecting objects. In order for this display mode to work, you must have [member Environment.ssil_enabled] set in your [WorldEnvironment].
</constant>
<constant name="VIEWPORT_DEBUG_DRAW_PSSM_SPLITS" value="14" enum="ViewportDebugDraw">
Update many docs with recent rendering changes
2020-04-16 23:05:25 +00: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 08:59:06 +00:00
</constant>
Added SSIL post processing effect
2021-08-03 07:07:32 +00:00
<constant name="VIEWPORT_DEBUG_DRAW_DECAL_ATLAS" value="15" enum="ViewportDebugDraw">
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 12:18:13 +00:00
</constant>
Added SSIL post processing effect
2021-08-03 07:07:32 +00:00
<constant name="VIEWPORT_DEBUG_DRAW_SDFGI" value="16" enum="ViewportDebugDraw">
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 12:18:13 +00:00
</constant>
Added SSIL post processing effect
2021-08-03 07:07:32 +00:00
<constant name="VIEWPORT_DEBUG_DRAW_SDFGI_PROBES" value="17" enum="ViewportDebugDraw">
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 12:18:13 +00:00
</constant>
Added SSIL post processing effect
2021-08-03 07:07:32 +00:00
<constant name="VIEWPORT_DEBUG_DRAW_GI_BUFFER" value="18" enum="ViewportDebugDraw">
doc: Sync classref with current source Add missing enum bindings.
2020-04-20 09:48:00 +00:00
</constant>
Added SSIL post processing effect
2021-08-03 07:07:32 +00:00
<constant name="VIEWPORT_DEBUG_DRAW_DISABLE_LOD" value="19" enum="ViewportDebugDraw">
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 02:17:47 +00:00
</constant>
Added SSIL post processing effect
2021-08-03 07:07:32 +00:00
<constant name="VIEWPORT_DEBUG_DRAW_CLUSTER_OMNI_LIGHTS" value="20" enum="ViewportDebugDraw">
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 02:17:47 +00:00
</constant>
Added SSIL post processing effect
2021-08-03 07:07:32 +00:00
<constant name="VIEWPORT_DEBUG_DRAW_CLUSTER_SPOT_LIGHTS" value="21" enum="ViewportDebugDraw">
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 02:17:47 +00:00
</constant>
Added SSIL post processing effect
2021-08-03 07:07:32 +00:00
<constant name="VIEWPORT_DEBUG_DRAW_CLUSTER_DECALS" value="22" enum="ViewportDebugDraw">
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 02:17:47 +00:00
</constant>
Added SSIL post processing effect
2021-08-03 07:07:32 +00:00
<constant name="VIEWPORT_DEBUG_DRAW_CLUSTER_REFLECTION_PROBES" value="23" enum="ViewportDebugDraw">
Clean up RenderingServer and its bindings * Rewrote bindings for RenderingServer. * They are now all up to date. * Several unused methods and deprecated features were cleaned up.
2021-07-01 02:17:47 +00:00
</constant>
Added SSIL post processing effect
2021-08-03 07:07:32 +00:00
<constant name="VIEWPORT_DEBUG_DRAW_OCCLUDERS" value="24" enum="ViewportDebugDraw">
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 16:40:24 +00:00
</constant>
Initial TAA implementation Initial TAA support based on the implementation in Spartan Engine. Motion vectors are correctly generated for camera and mesh movement, but there is no support for other things like particles or skeleton deformations.
2022-04-04 14:10:22 +00:00
<constant name="VIEWPORT_DEBUG_DRAW_MOTION_VECTORS" value="25" enum="ViewportDebugDraw">
</constant>
Adding Variable Rate Shading support to Godot Improve GI renderer and add VRS support Implement render device has_feature and move subgroup settings to limit_get
2022-02-11 11:33:54 +00:00
<constant name="VIEWPORT_VRS_DISABLED" value="0" enum="ViewportVRSMode">
VRS is disabled.
</constant>
<constant name="VIEWPORT_VRS_TEXTURE" value="1" enum="ViewportVRSMode">
VRS uses a texture. Note, for stereoscopic use a texture atlas with a texture for each view.
</constant>
<constant name="VIEWPORT_VRS_XR" value="2" enum="ViewportVRSMode">
VRS texture is supplied by the primary [XRInterface].
</constant>
<constant name="VIEWPORT_VRS_MAX" value="3" enum="ViewportVRSMode">
Represents the size of the [enum ViewportVRSMode] enum.
</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 02:17:47 +00:00
<constant name="SKY_MODE_AUTOMATIC" value="0" enum="SkyMode">
</constant>
Add incremental update mode to sky
2020-07-11 00:07:30 +00: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 12:35:31 +00: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 08:59:06 +00: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 02:17:47 +00:00
<constant name="SKY_MODE_INCREMENTAL" value="2" enum="SkyMode">
</constant>
Add incremental update mode to sky
2020-07-11 00:07:30 +00:00
<constant name="SKY_MODE_REALTIME" value="3" enum="SkyMode">
Update many docs with recent rendering changes
2020-04-16 23:05:25 +00: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 08:59:06 +00: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-16 23:05:25 +00: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 08:59:06 +00:00
</constant>
<constant name="ENV_AMBIENT_SOURCE_DISABLED" value="1" enum="EnvironmentAmbientSource">
Update many docs with recent rendering changes
2020-04-16 23:05:25 +00: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 08:59:06 +00:00
</constant>
<constant name="ENV_AMBIENT_SOURCE_COLOR" value="2" enum="EnvironmentAmbientSource">
Update many docs with recent rendering changes
2020-04-16 23:05:25 +00: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 08:59:06 +00:00
</constant>
<constant name="ENV_AMBIENT_SOURCE_SKY" value="3" enum="EnvironmentAmbientSource">
Update many docs with recent rendering changes
2020-04-16 23:05:25 +00: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 08:59:06 +00:00
</constant>
<constant name="ENV_REFLECTION_SOURCE_BG" value="0" enum="EnvironmentReflectionSource">
Update many docs with recent rendering changes
2020-04-16 23:05:25 +00: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 08:59:06 +00:00
</constant>
<constant name="ENV_REFLECTION_SOURCE_DISABLED" value="1" enum="EnvironmentReflectionSource">
Update many docs with recent rendering changes
2020-04-16 23:05:25 +00: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 08:59:06 +00:00
</constant>
<constant name="ENV_REFLECTION_SOURCE_SKY" value="2" enum="EnvironmentReflectionSource">
Update many docs with recent rendering changes
2020-04-16 23:05:25 +00: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 08:59:06 +00:00
</constant>
<constant name="ENV_GLOW_BLEND_MODE_ADDITIVE" value="0" enum="EnvironmentGlowBlendMode">
Update many docs with recent rendering changes
2020-04-16 23:05:25 +00: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 08:59:06 +00:00
</constant>
<constant name="ENV_GLOW_BLEND_MODE_SCREEN" value="1" enum="EnvironmentGlowBlendMode">
Update many docs with recent rendering changes
2020-04-16 23:05:25 +00: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 08:59:06 +00:00
</constant>
<constant name="ENV_GLOW_BLEND_MODE_SOFTLIGHT" value="2" enum="EnvironmentGlowBlendMode">
Update many docs with recent rendering changes
2020-04-16 23:05:25 +00: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 08:59:06 +00:00
</constant>
<constant name="ENV_GLOW_BLEND_MODE_REPLACE" value="3" enum="EnvironmentGlowBlendMode">
Update many docs with recent rendering changes
2020-04-16 23:05:25 +00: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 08:59:06 +00:00
</constant>
<constant name="ENV_GLOW_BLEND_MODE_MIX" value="4" enum="EnvironmentGlowBlendMode">
Update many docs with recent rendering changes
2020-04-16 23:05:25 +00: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 08:59:06 +00:00
</constant>
<constant name="ENV_TONE_MAPPER_LINEAR" value="0" enum="EnvironmentToneMapper">
Improve documentation for tonemapping operators
2022-03-22 11:14:51 +00:00
Output color as they came in. This can cause bright lighting to look blown out, with noticeable clipping in the output colors.
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 08:59:06 +00:00
</constant>
<constant name="ENV_TONE_MAPPER_REINHARD" value="1" enum="EnvironmentToneMapper">
Improve documentation for tonemapping operators
2022-03-22 11:14:51 +00:00
Use the Reinhard tonemapper. Performs a variation on rendered pixels' colors by this formula: [code]color = color / (1 + color)[/code]. This avoids clipping bright highlights, but the resulting image can look a bit dull.
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 08:59:06 +00:00
</constant>
<constant name="ENV_TONE_MAPPER_FILMIC" value="2" enum="EnvironmentToneMapper">
Improve documentation for tonemapping operators
2022-03-22 11:14:51 +00:00
Use the filmic tonemapper. This avoids clipping bright highlights, with a resulting image that usually looks more vivid than [constant ENV_TONE_MAPPER_REINHARD].
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 08:59:06 +00:00
</constant>
<constant name="ENV_TONE_MAPPER_ACES" value="3" enum="EnvironmentToneMapper">
Improve documentation for tonemapping operators
2022-03-22 11:14:51 +00:00
Use the Academy Color Encoding System tonemapper. ACES is slightly more expensive than other options, but it handles bright lighting in a more realistic fashion by desaturating it as it becomes brighter. ACES typically has a more contrasted output compared to [constant ENV_TONE_MAPPER_REINHARD] and [constant ENV_TONE_MAPPER_FILMIC].
[b]Note:[/b] This tonemapping operator is called "ACES Fitted" in Godot 3.x.
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 08:59:06 +00:00
</constant>
Fix typo in SSR roughness quality enum value names
2022-02-28 00:06:26 +00:00
<constant name="ENV_SSR_ROUGHNESS_QUALITY_DISABLED" value="0" enum="EnvironmentSSRRoughnessQuality">
Lowest quality of roughness filter for screen-space reflections. Rough materials will not have blurrier screen-space reflections compared to smooth (non-rough) materials. This is the fastest option.
doc: Sync classref with current source Add missing enum bindings.
2020-04-20 09:48:00 +00:00
</constant>
Fix typo in SSR roughness quality enum value names
2022-02-28 00:06:26 +00:00
<constant name="ENV_SSR_ROUGHNESS_QUALITY_LOW" value="1" enum="EnvironmentSSRRoughnessQuality">
Low quality of roughness filter for screen-space reflections.
doc: Sync classref with current source Add missing enum bindings.
2020-04-20 09:48:00 +00:00
</constant>
Fix typo in SSR roughness quality enum value names
2022-02-28 00:06:26 +00:00
<constant name="ENV_SSR_ROUGHNESS_QUALITY_MEDIUM" value="2" enum="EnvironmentSSRRoughnessQuality">
Medium quality of roughness filter for screen-space reflections.
doc: Sync classref with current source Add missing enum bindings.
2020-04-20 09:48:00 +00:00
</constant>
Fix typo in SSR roughness quality enum value names
2022-02-28 00:06:26 +00:00
<constant name="ENV_SSR_ROUGHNESS_QUALITY_HIGH" value="3" enum="EnvironmentSSRRoughnessQuality">
High quality of roughness filter for screen-space reflections. This is the slowest option.
doc: Sync classref with current source Add missing enum bindings.
2020-04-20 09:48:00 +00:00
</constant>
Port ASSAO to Godot to replace SAO
2020-12-08 05:37:09 +00:00
<constant name="ENV_SSAO_QUALITY_VERY_LOW" value="0" enum="EnvironmentSSAOQuality">
Expose RenderingServer SSIL quality setter methods This allows changing SSIL quality at run-time in a project.
2022-01-06 01:35:49 +00:00
Lowest quality of screen-space ambient occlusion.
Fix VisualServer bindings.
2020-02-16 17:55:40 +00:00
</constant>
Port ASSAO to Godot to replace SAO
2020-12-08 05:37:09 +00:00
<constant name="ENV_SSAO_QUALITY_LOW" value="1" enum="EnvironmentSSAOQuality">
Expose RenderingServer SSIL quality setter methods This allows changing SSIL quality at run-time in a project.
2022-01-06 01:35:49 +00:00
Low quality screen-space ambient occlusion.
Port ASSAO to Godot to replace SAO
2020-12-08 05:37:09 +00:00
</constant>
<constant name="ENV_SSAO_QUALITY_MEDIUM" value="2" enum="EnvironmentSSAOQuality">
Expose RenderingServer SSIL quality setter methods This allows changing SSIL quality at run-time in a project.
2022-01-06 01:35:49 +00:00
Medium quality screen-space ambient occlusion.
Fix VisualServer bindings.
2020-02-16 17:55:40 +00:00
</constant>
Port ASSAO to Godot to replace SAO
2020-12-08 05:37:09 +00:00
<constant name="ENV_SSAO_QUALITY_HIGH" value="3" enum="EnvironmentSSAOQuality">
Expose RenderingServer SSIL quality setter methods This allows changing SSIL quality at run-time in a project.
2022-01-06 01:35:49 +00:00
High quality screen-space ambient occlusion.
Fix VisualServer bindings.
2020-02-16 17:55:40 +00:00
</constant>
Port ASSAO to Godot to replace SAO
2020-12-08 05:37:09 +00:00
<constant name="ENV_SSAO_QUALITY_ULTRA" value="4" enum="EnvironmentSSAOQuality">
Expose RenderingServer SSIL quality setter methods This allows changing SSIL quality at run-time in a project.
2022-01-06 01:35:49 +00:00
Highest quality screen-space ambient occlusion. Uses the adaptive target setting which can be dynamically adjusted to smoothly balance performance and visual quality.
</constant>
<constant name="ENV_SSIL_QUALITY_VERY_LOW" value="0" enum="EnvironmentSSILQuality">
Lowest quality of screen-space indirect lighting.
</constant>
<constant name="ENV_SSIL_QUALITY_LOW" value="1" enum="EnvironmentSSILQuality">
Low quality screen-space indirect lighting.
</constant>
<constant name="ENV_SSIL_QUALITY_MEDIUM" value="2" enum="EnvironmentSSILQuality">
High quality screen-space indirect lighting.
</constant>
<constant name="ENV_SSIL_QUALITY_HIGH" value="3" enum="EnvironmentSSILQuality">
High quality screen-space indirect lighting.
</constant>
<constant name="ENV_SSIL_QUALITY_ULTRA" value="4" enum="EnvironmentSSILQuality">
Highest quality screen-space indirect lighting. Uses the adaptive target 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 08:59:06 +00:00
</constant>
Tweak default SDFGI settings for better quality - Enable Read Sky Light to get proper outdoors lighting out of the box. - Set bounce feedback to 0.5 by default to get a better quality result. - Higher values may cause infinite feedback with bright surfaces. - Increase the number of frames to converge to improve quality at the cost of latency. Most scenes are fairly static after all. - Use 75% Y scale by default as most scenes are not highly vertical. - Reorder the Y scale enum to go from the lowest Y scale to the highest. Also rename the "Disabled" setting to "100%" for clarity.
2021-05-23 17:10:26 +00:00
<constant name="ENV_SDFGI_Y_SCALE_50_PERCENT" value="0" enum="EnvironmentSDFGIYScale">
doc: Sync classref with current source Add missing enum bindings.
2020-04-20 09:48:00 +00: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 02:17:47 +00: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 08:59:06 +00:00
</constant>
Tweak default SDFGI settings for better quality - Enable Read Sky Light to get proper outdoors lighting out of the box. - Set bounce feedback to 0.5 by default to get a better quality result. - Higher values may cause infinite feedback with bright surfaces. - Increase the number of frames to converge to improve quality at the cost of latency. Most scenes are fairly static after all. - Use 75% Y scale by default as most scenes are not highly vertical. - Reorder the Y scale enum to go from the lowest Y scale to the highest. Also rename the "Disabled" setting to "100%" for clarity.
2021-05-23 17:10:26 +00:00
<constant name="ENV_SDFGI_Y_SCALE_100_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 08:59:06 +00: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 02:17:47 +00: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 08:59:06 +00: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 02:17:47 +00: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 08:59:06 +00: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 02:17:47 +00: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 08:59:06 +00: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 02:17:47 +00: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 08:59:06 +00: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 02:17:47 +00: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 08:59:06 +00: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 02:17:47 +00: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 09:48:00 +00: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 02:17:47 +00: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 09:48:00 +00: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 02:17:47 +00: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 09:48:00 +00: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 02:17:47 +00: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 09:48:00 +00: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 02:17:47 +00: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 09:48:00 +00: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 02:17:47 +00: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 09:48:00 +00: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 02:17:47 +00:00
<constant name="ENV_SDFGI_CONVERGE_IN_20_FRAMES" value="3" enum="EnvironmentSDFGIFramesToConverge">
classref: Sync with current source
2017-10-21 10:02:08 +00: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 02:17:47 +00:00
<constant name="ENV_SDFGI_CONVERGE_IN_25_FRAMES" value="4" enum="EnvironmentSDFGIFramesToConverge">
classref: Sync with current source
2017-10-21 10:02:08 +00: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 02:17:47 +00:00
<constant name="ENV_SDFGI_CONVERGE_IN_30_FRAMES" value="5" enum="EnvironmentSDFGIFramesToConverge">
classref: Sync with current source
2017-10-21 10:02:08 +00: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 02:17:47 +00:00
<constant name="ENV_SDFGI_CONVERGE_MAX" value="6" enum="EnvironmentSDFGIFramesToConverge">
classref: Sync with current source
2017-10-21 10:02:08 +00: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 02:17:47 +00: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 16:40:24 +00: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 02:17:47 +00: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 16:40:24 +00: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 02:17:47 +00: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 16:40:24 +00:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 22:16:30 +00:00
<constant name="INSTANCE_NONE" value="0" enum="InstanceType">
Added documentation for VisualServer
2017-11-26 15:37:37 +00:00
The instance does not have a type.
classref: Sync with current source
2017-10-21 10:02:08 +00:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 22:16:30 +00:00
<constant name="INSTANCE_MESH" value="1" enum="InstanceType">
Added documentation for VisualServer
2017-11-26 15:37:37 +00:00
The instance is a mesh.
classref: Sync with current source
2017-10-21 10:02:08 +00:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 22:16:30 +00:00
<constant name="INSTANCE_MULTIMESH" value="2" enum="InstanceType">
Added documentation for VisualServer
2017-11-26 15:37:37 +00:00
The instance is a multimesh.
classref: Sync with current source
2017-10-21 10:02:08 +00: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 01:55:11 +00:00
<constant name="INSTANCE_PARTICLES" value="3" enum="InstanceType">
Added documentation for VisualServer
2017-11-26 15:37:37 +00:00
The instance is a particle emitter.
classref: Sync with current source
2017-10-21 10:02:08 +00: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 01:55:11 +00:00
<constant name="INSTANCE_PARTICLES_COLLISION" value="4" enum="InstanceType">
doc: Sync classref with current source
2020-10-12 08:57:54 +00: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 01:55:11 +00:00
<constant name="INSTANCE_LIGHT" value="5" enum="InstanceType">
Added documentation for VisualServer
2017-11-26 15:37:37 +00:00
The instance is a light.
classref: Sync with current source
2017-10-21 10:02:08 +00: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 01:55:11 +00:00
<constant name="INSTANCE_REFLECTION_PROBE" value="6" enum="InstanceType">
Document most VisualServer functions
2020-01-05 08:33:16 +00:00
The instance is a reflection probe.
classref: Sync with current source
2017-10-21 10:02:08 +00: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 01:55:11 +00:00
<constant name="INSTANCE_DECAL" value="7" enum="InstanceType">
doc: Sync classref with current source Add missing enum bindings.
2020-04-20 09:48:00 +00: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 01:55:11 +00: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-04 22:47:26 +00:00
The instance is a VoxelGI.
classref: Sync with current source
2017-10-21 10:02:08 +00: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 01:55:11 +00: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 08:10:34 +00:00
The instance is a lightmap.
Bind TextEdit.deselect and update documentation
2017-12-16 19:34:16 +00: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 01:55:11 +00: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 16:40:24 +00: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 02:17:47 +00: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 11:28:55 +00: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 09:10:53 +00:00
Represents the size of the [enum InstanceType] enum.
classref: Sync with current source
2017-10-21 10:02:08 +00: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 01:55:11 +00:00
<constant name="INSTANCE_GEOMETRY_MASK" value="14" enum="InstanceType">
Added documentation for VisualServer
2017-11-26 15:37:37 +00:00
A combination of the flags of geometry instances (mesh, multimesh, immediate and particles).
classref: Sync with current source
2017-10-21 10:02:08 +00:00
</constant>
doc: Sync classref with current source
2018-02-19 09:47:16 +00:00
<constant name="INSTANCE_FLAG_USE_BAKED_LIGHT" value="0" enum="InstanceFlags">
Updated many VisualServer functions
2020-01-04 07:24:40 +00:00
Allows the instance to be used in baked lighting.
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 08:59:06 +00: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 09:48:00 +00: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 08:59:06 +00:00
</constant>
<constant name="INSTANCE_FLAG_DRAW_NEXT_FRAME_IF_VISIBLE" value="2" enum="InstanceFlags">
Updated many VisualServer functions
2020-01-04 07:24:40 +00: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 09:56:21 +00: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 16:40:24 +00: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 09:10:53 +00:00
Represents the size of the [enum InstanceFlags] enum.
doc: Sync classref with current source
2018-02-19 09:47:16 +00:00
</constant>
<constant name="SHADOW_CASTING_SETTING_OFF" value="0" enum="ShadowCastingSetting">
Updated many VisualServer functions
2020-01-04 07:24:40 +00:00
Disable shadows from this instance.
doc: Sync classref with current source
2018-02-19 09:47:16 +00:00
</constant>
<constant name="SHADOW_CASTING_SETTING_ON" value="1" enum="ShadowCastingSetting">
Updated many VisualServer functions
2020-01-04 07:24:40 +00:00
Cast shadows from this instance.
doc: Sync classref with current source
2018-02-19 09:47:16 +00:00
</constant>
<constant name="SHADOW_CASTING_SETTING_DOUBLE_SIDED" value="2" enum="ShadowCastingSetting">
Updated many VisualServer functions
2020-01-04 07:24:40 +00: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 09:47:16 +00:00
</constant>
<constant name="SHADOW_CASTING_SETTING_SHADOWS_ONLY" value="3" enum="ShadowCastingSetting">
Updated many VisualServer functions
2020-01-04 07:24:40 +00:00
Only render the shadows from the object. The object itself will not be drawn.
doc: Sync classref with current source
2018-02-19 09:47:16 +00: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 18:17:34 +00: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 02:17:47 +00: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 22:16:30 +00:00
<constant name="NINE_PATCH_STRETCH" value="0" enum="NinePatchAxisMode">
Added documentation for VisualServer
2017-11-26 15:37:37 +00:00
The nine patch gets stretched where needed.
classref: Sync with current source
2017-10-21 10:02:08 +00:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 22:16:30 +00:00
<constant name="NINE_PATCH_TILE" value="1" enum="NinePatchAxisMode">
Added documentation for VisualServer
2017-11-26 15:37:37 +00:00
The nine patch gets filled with tiles where needed.
classref: Sync with current source
2017-10-21 10:02:08 +00:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 22:16:30 +00:00
<constant name="NINE_PATCH_TILE_FIT" value="2" enum="NinePatchAxisMode">
Added documentation for VisualServer
2017-11-26 15:37:37 +00: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 10:02:08 +00: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 08:59:06 +00:00
<constant name="CANVAS_ITEM_TEXTURE_FILTER_DEFAULT" value="0" enum="CanvasItemTextureFilter">
Update many docs with recent rendering changes
2020-04-16 23:05:25 +00: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 08:59:06 +00:00
</constant>
<constant name="CANVAS_ITEM_TEXTURE_FILTER_NEAREST" value="1" enum="CanvasItemTextureFilter">
Update many docs with recent rendering changes
2020-04-16 23:05:25 +00: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 08:59:06 +00:00
</constant>
<constant name="CANVAS_ITEM_TEXTURE_FILTER_LINEAR" value="2" enum="CanvasItemTextureFilter">
Update many docs with recent rendering changes
2020-04-16 23:05:25 +00: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 08:59:06 +00:00
</constant>
Fix MIMPAMPS typos in constants throughout the engine
2020-02-19 23:31:43 +00:00
<constant name="CANVAS_ITEM_TEXTURE_FILTER_NEAREST_WITH_MIPMAPS" value="3" enum="CanvasItemTextureFilter">
Update many docs with recent rendering changes
2020-04-16 23:05:25 +00: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 08:59:06 +00:00
</constant>
<constant name="CANVAS_ITEM_TEXTURE_FILTER_LINEAR_WITH_MIPMAPS" value="4" enum="CanvasItemTextureFilter">
Update many docs with recent rendering changes
2020-04-16 23:05:25 +00: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 08:59:06 +00:00
</constant>
Fix MIMPAMPS typos in constants throughout the engine
2020-02-19 23:31:43 +00:00
<constant name="CANVAS_ITEM_TEXTURE_FILTER_NEAREST_WITH_MIPMAPS_ANISOTROPIC" value="5" enum="CanvasItemTextureFilter">
Update many docs with recent rendering changes
2020-04-16 23:05:25 +00: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 08:59:06 +00: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-16 23:05:25 +00: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 08:59:06 +00:00
</constant>
<constant name="CANVAS_ITEM_TEXTURE_FILTER_MAX" value="7" enum="CanvasItemTextureFilter">
Update many docs with recent rendering changes
2020-04-16 23:05:25 +00: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 08:59:06 +00:00
</constant>
<constant name="CANVAS_ITEM_TEXTURE_REPEAT_DEFAULT" value="0" enum="CanvasItemTextureRepeat">
Update many docs with recent rendering changes
2020-04-16 23:05:25 +00: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 08:59:06 +00:00
</constant>
<constant name="CANVAS_ITEM_TEXTURE_REPEAT_DISABLED" value="1" enum="CanvasItemTextureRepeat">
Update many docs with recent rendering changes
2020-04-16 23:05:25 +00: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 08:59:06 +00:00
</constant>
<constant name="CANVAS_ITEM_TEXTURE_REPEAT_ENABLED" value="2" enum="CanvasItemTextureRepeat">
Update many docs with recent rendering changes
2020-04-16 23:05:25 +00: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 08:59:06 +00:00
</constant>
<constant name="CANVAS_ITEM_TEXTURE_REPEAT_MIRROR" value="3" enum="CanvasItemTextureRepeat">
Update many docs with recent rendering changes
2020-04-16 23:05:25 +00: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 08:59:06 +00:00
</constant>
<constant name="CANVAS_ITEM_TEXTURE_REPEAT_MAX" value="4" enum="CanvasItemTextureRepeat">
Update many docs with recent rendering changes
2020-04-16 23:05:25 +00: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 08:59:06 +00:00
</constant>
doc: Sync classref with current source + fixup some bindings Includes various changes triggered by the refactoring of method bindings.
2020-11-04 14:38:26 +00:00
<constant name="CANVAS_GROUP_MODE_DISABLED" value="0" enum="CanvasGroupMode">
</constant>
Implement multiple clip_children modes for CanvasItems
2022-10-12 19:45:47 +00:00
<constant name="CANVAS_GROUP_MODE_CLIP_ONLY" value="1" enum="CanvasGroupMode">
doc: Sync classref with current source + fixup some bindings Includes various changes triggered by the refactoring of method bindings.
2020-11-04 14:38:26 +00:00
</constant>
Implement multiple clip_children modes for CanvasItems
2022-10-12 19:45:47 +00:00
<constant name="CANVAS_GROUP_MODE_CLIP_AND_DRAW" value="2" enum="CanvasGroupMode">
</constant>
<constant name="CANVAS_GROUP_MODE_TRANSPARENT" value="3" enum="CanvasGroupMode">
doc: Sync classref with current source + fixup some bindings Includes various changes triggered by the refactoring of method bindings.
2020-11-04 14:38:26 +00:00
</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 15:37:37 +00:00
Adds light color additive to the canvas.
classref: Sync with current source
2017-10-21 10:02:08 +00:00
</constant>
doc: Sync classref with current source + fixup some bindings Includes various changes triggered by the refactoring of method bindings.
2020-11-04 14:38:26 +00:00
<constant name="CANVAS_LIGHT_BLEND_MODE_SUB" value="1" enum="CanvasLightBlendMode">
Added documentation for VisualServer
2017-11-26 15:37:37 +00:00
Adds light color subtractive to the canvas.
classref: Sync with current source
2017-10-21 10:02:08 +00:00
</constant>
doc: Sync classref with current source + fixup some bindings Includes various changes triggered by the refactoring of method bindings.
2020-11-04 14:38:26 +00:00
<constant name="CANVAS_LIGHT_BLEND_MODE_MIX" value="2" enum="CanvasLightBlendMode">
Added documentation for VisualServer
2017-11-26 15:37:37 +00:00
The light adds color depending on transparency.
classref: Sync with current source
2017-10-21 10:02:08 +00:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 22:16:30 +00:00
<constant name="CANVAS_LIGHT_FILTER_NONE" value="0" enum="CanvasLightShadowFilter">
Finish documenting VisualServer
2020-01-05 23:36:50 +00:00
Do not apply a filter to canvas light shadows.
classref: Sync with current source
2017-10-21 10:02:08 +00: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 08:59:06 +00:00
<constant name="CANVAS_LIGHT_FILTER_PCF5" value="1" enum="CanvasLightShadowFilter">
Finish documenting VisualServer
2020-01-05 23:36:50 +00:00
Use PCF5 filtering to filter canvas light shadows.
classref: Sync with current source
2017-10-21 10:02:08 +00: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 08:59:06 +00:00
<constant name="CANVAS_LIGHT_FILTER_PCF13" value="2" enum="CanvasLightShadowFilter">
Finish documenting VisualServer
2020-01-05 23:36:50 +00:00
Use PCF13 filtering to filter canvas light shadows.
classref: Sync with current source
2017-10-21 10:02:08 +00: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 08:59:06 +00:00
<constant name="CANVAS_LIGHT_FILTER_MAX" value="3" enum="CanvasLightShadowFilter">
Update many docs with recent rendering changes
2020-04-16 23:05:25 +00: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 08:59:06 +00:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 22:16:30 +00:00
<constant name="CANVAS_OCCLUDER_POLYGON_CULL_DISABLED" value="0" enum="CanvasOccluderPolygonCullMode">
Added documentation for VisualServer
2017-11-26 15:37:37 +00:00
Culling of the canvas occluder is disabled.
classref: Sync with current source
2017-10-21 10:02:08 +00:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 22:16:30 +00:00
<constant name="CANVAS_OCCLUDER_POLYGON_CULL_CLOCKWISE" value="1" enum="CanvasOccluderPolygonCullMode">
Added documentation for VisualServer
2017-11-26 15:37:37 +00:00
Culling of the canvas occluder is clockwise.
classref: Sync with current source
2017-10-21 10:02:08 +00:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 22:16:30 +00:00
<constant name="CANVAS_OCCLUDER_POLYGON_CULL_COUNTER_CLOCKWISE" value="2" enum="CanvasOccluderPolygonCullMode">
Added documentation for VisualServer
2017-11-26 15:37:37 +00:00
Culling of the canvas occluder is counterclockwise.
classref: Sync with current source
2017-10-21 10:02:08 +00:00
</constant>
Rename `uniform` to `parameter` across the engine
2022-08-27 09:22:43 +00:00
<constant name="GLOBAL_VAR_TYPE_BOOL" value="0" enum="GlobalShaderParameterType">
doc: Sync classref with current source Add missing enum bindings.
2020-04-20 09:48:00 +00:00
</constant>
Rename `uniform` to `parameter` across the engine
2022-08-27 09:22:43 +00:00
<constant name="GLOBAL_VAR_TYPE_BVEC2" value="1" enum="GlobalShaderParameterType">
doc: Sync classref with current source Add missing enum bindings.
2020-04-20 09:48:00 +00:00
</constant>
Rename `uniform` to `parameter` across the engine
2022-08-27 09:22:43 +00:00
<constant name="GLOBAL_VAR_TYPE_BVEC3" value="2" enum="GlobalShaderParameterType">
doc: Sync classref with current source Add missing enum bindings.
2020-04-20 09:48:00 +00:00
</constant>
Rename `uniform` to `parameter` across the engine
2022-08-27 09:22:43 +00:00
<constant name="GLOBAL_VAR_TYPE_BVEC4" value="3" enum="GlobalShaderParameterType">
doc: Sync classref with current source Add missing enum bindings.
2020-04-20 09:48:00 +00:00
</constant>
Rename `uniform` to `parameter` across the engine
2022-08-27 09:22:43 +00:00
<constant name="GLOBAL_VAR_TYPE_INT" value="4" enum="GlobalShaderParameterType">
doc: Sync classref with current source Add missing enum bindings.
2020-04-20 09:48:00 +00:00
</constant>
Rename `uniform` to `parameter` across the engine
2022-08-27 09:22:43 +00:00
<constant name="GLOBAL_VAR_TYPE_IVEC2" value="5" enum="GlobalShaderParameterType">
doc: Sync classref with current source Add missing enum bindings.
2020-04-20 09:48:00 +00:00
</constant>
Rename `uniform` to `parameter` across the engine
2022-08-27 09:22:43 +00:00
<constant name="GLOBAL_VAR_TYPE_IVEC3" value="6" enum="GlobalShaderParameterType">
doc: Sync classref with current source Add missing enum bindings.
2020-04-20 09:48:00 +00:00
</constant>
Rename `uniform` to `parameter` across the engine
2022-08-27 09:22:43 +00:00
<constant name="GLOBAL_VAR_TYPE_IVEC4" value="7" enum="GlobalShaderParameterType">
doc: Sync classref with current source Add missing enum bindings.
2020-04-20 09:48:00 +00:00
</constant>
Rename `uniform` to `parameter` across the engine
2022-08-27 09:22:43 +00:00
<constant name="GLOBAL_VAR_TYPE_RECT2I" value="8" enum="GlobalShaderParameterType">
doc: Sync classref with current source Add missing enum bindings.
2020-04-20 09:48:00 +00:00
</constant>
Rename `uniform` to `parameter` across the engine
2022-08-27 09:22:43 +00:00
<constant name="GLOBAL_VAR_TYPE_UINT" value="9" enum="GlobalShaderParameterType">
doc: Sync classref with current source Add missing enum bindings.
2020-04-20 09:48:00 +00:00
</constant>
Rename `uniform` to `parameter` across the engine
2022-08-27 09:22:43 +00:00
<constant name="GLOBAL_VAR_TYPE_UVEC2" value="10" enum="GlobalShaderParameterType">
doc: Sync classref with current source Add missing enum bindings.
2020-04-20 09:48:00 +00:00
</constant>
Rename `uniform` to `parameter` across the engine
2022-08-27 09:22:43 +00:00
<constant name="GLOBAL_VAR_TYPE_UVEC3" value="11" enum="GlobalShaderParameterType">
doc: Sync classref with current source Add missing enum bindings.
2020-04-20 09:48:00 +00:00
</constant>
Rename `uniform` to `parameter` across the engine
2022-08-27 09:22:43 +00:00
<constant name="GLOBAL_VAR_TYPE_UVEC4" value="12" enum="GlobalShaderParameterType">
doc: Sync classref with current source Add missing enum bindings.
2020-04-20 09:48:00 +00:00
</constant>
Rename `uniform` to `parameter` across the engine
2022-08-27 09:22:43 +00:00
<constant name="GLOBAL_VAR_TYPE_FLOAT" value="13" enum="GlobalShaderParameterType">
doc: Sync classref with current source Add missing enum bindings.
2020-04-20 09:48:00 +00:00
</constant>
Rename `uniform` to `parameter` across the engine
2022-08-27 09:22:43 +00:00
<constant name="GLOBAL_VAR_TYPE_VEC2" value="14" enum="GlobalShaderParameterType">
doc: Sync classref with current source Add missing enum bindings.
2020-04-20 09:48:00 +00:00
</constant>
Rename `uniform` to `parameter` across the engine
2022-08-27 09:22:43 +00:00
<constant name="GLOBAL_VAR_TYPE_VEC3" value="15" enum="GlobalShaderParameterType">
doc: Sync classref with current source Add missing enum bindings.
2020-04-20 09:48:00 +00:00
</constant>
Rename `uniform` to `parameter` across the engine
2022-08-27 09:22:43 +00:00
<constant name="GLOBAL_VAR_TYPE_VEC4" value="16" enum="GlobalShaderParameterType">
doc: Sync classref with current source Add missing enum bindings.
2020-04-20 09:48:00 +00:00
</constant>
Rename `uniform` to `parameter` across the engine
2022-08-27 09:22:43 +00:00
<constant name="GLOBAL_VAR_TYPE_COLOR" value="17" enum="GlobalShaderParameterType">
doc: Sync classref with current source Add missing enum bindings.
2020-04-20 09:48:00 +00:00
</constant>
Rename `uniform` to `parameter` across the engine
2022-08-27 09:22:43 +00:00
<constant name="GLOBAL_VAR_TYPE_RECT2" value="18" enum="GlobalShaderParameterType">
doc: Sync classref with current source Add missing enum bindings.
2020-04-20 09:48:00 +00:00
</constant>
Rename `uniform` to `parameter` across the engine
2022-08-27 09:22:43 +00:00
<constant name="GLOBAL_VAR_TYPE_MAT2" value="19" enum="GlobalShaderParameterType">
doc: Sync classref with current source Add missing enum bindings.
2020-04-20 09:48:00 +00:00
</constant>
Rename `uniform` to `parameter` across the engine
2022-08-27 09:22:43 +00:00
<constant name="GLOBAL_VAR_TYPE_MAT3" value="20" enum="GlobalShaderParameterType">
doc: Sync classref with current source Add missing enum bindings.
2020-04-20 09:48:00 +00:00
</constant>
Rename `uniform` to `parameter` across the engine
2022-08-27 09:22:43 +00:00
<constant name="GLOBAL_VAR_TYPE_MAT4" value="21" enum="GlobalShaderParameterType">
doc: Sync classref with current source Add missing enum bindings.
2020-04-20 09:48:00 +00:00
</constant>
Rename `uniform` to `parameter` across the engine
2022-08-27 09:22:43 +00:00
<constant name="GLOBAL_VAR_TYPE_TRANSFORM_2D" value="22" enum="GlobalShaderParameterType">
doc: Sync classref with current source Add missing enum bindings.
2020-04-20 09:48:00 +00:00
</constant>
Rename `uniform` to `parameter` across the engine
2022-08-27 09:22:43 +00:00
<constant name="GLOBAL_VAR_TYPE_TRANSFORM" value="23" enum="GlobalShaderParameterType">
doc: Sync classref with current source Add missing enum bindings.
2020-04-20 09:48:00 +00:00
</constant>
Rename `uniform` to `parameter` across the engine
2022-08-27 09:22:43 +00:00
<constant name="GLOBAL_VAR_TYPE_SAMPLER2D" value="24" enum="GlobalShaderParameterType">
doc: Sync classref with current source Add missing enum bindings.
2020-04-20 09:48:00 +00:00
</constant>
Rename `uniform` to `parameter` across the engine
2022-08-27 09:22:43 +00:00
<constant name="GLOBAL_VAR_TYPE_SAMPLER2DARRAY" value="25" enum="GlobalShaderParameterType">
doc: Sync classref with current source Add missing enum bindings.
2020-04-20 09:48:00 +00:00
</constant>
Rename `uniform` to `parameter` across the engine
2022-08-27 09:22:43 +00:00
<constant name="GLOBAL_VAR_TYPE_SAMPLER3D" value="26" enum="GlobalShaderParameterType">
doc: Sync classref with current source Add missing enum bindings.
2020-04-20 09:48:00 +00:00
</constant>
Rename `uniform` to `parameter` across the engine
2022-08-27 09:22:43 +00:00
<constant name="GLOBAL_VAR_TYPE_SAMPLERCUBE" value="27" enum="GlobalShaderParameterType">
doc: Sync classref with current source Add missing enum bindings.
2020-04-20 09:48:00 +00:00
</constant>
Rename `uniform` to `parameter` across the engine
2022-08-27 09:22:43 +00:00
<constant name="GLOBAL_VAR_TYPE_MAX" value="28" enum="GlobalShaderParameterType">
doc: Sync classref with current source Add missing enum bindings.
2020-04-20 09:48:00 +00: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-02 23:14:19 +00:00
<constant name="RENDERING_INFO_TOTAL_OBJECTS_IN_FRAME" value="0" enum="RenderingInfo">
classref: Sync with current source
2017-10-21 10:02:08 +00: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-02 23:14:19 +00:00
<constant name="RENDERING_INFO_TOTAL_PRIMITIVES_IN_FRAME" value="1" enum="RenderingInfo">
classref: Sync with current source
2017-10-21 10:02:08 +00: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-02 23:14:19 +00:00
<constant name="RENDERING_INFO_TOTAL_DRAW_CALLS_IN_FRAME" value="2" enum="RenderingInfo">
classref: Sync with current source
2017-10-21 10:02:08 +00: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-02 23:14:19 +00:00
<constant name="RENDERING_INFO_TEXTURE_MEM_USED" value="3" enum="RenderingInfo">
classref: Sync with current source
2017-10-21 10:02:08 +00: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-02 23:14:19 +00:00
<constant name="RENDERING_INFO_BUFFER_MEM_USED" value="4" enum="RenderingInfo">
classref: Sync with current source
2017-10-21 10:02:08 +00: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-02 23:14:19 +00:00
<constant name="RENDERING_INFO_VIDEO_MEM_USED" value="5" enum="RenderingInfo">
classref: Sync with current source
2017-10-21 10:02:08 +00:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 22:16:30 +00:00
<constant name="FEATURE_SHADERS" value="0" enum="Features">
Finish documenting VisualServer
2020-01-05 23:36:50 +00:00
Hardware supports shaders. This enum is currently unused in Godot 3.x.
classref: Sync with current source
2017-10-21 10:02:08 +00:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 22:16:30 +00:00
<constant name="FEATURE_MULTITHREADED" value="1" enum="Features">
Finish documenting VisualServer
2020-01-05 23:36:50 +00:00
Hardware supports multithreading. This enum is currently unused in Godot 3.x.
classref: Sync with current source
2017-10-21 10:02:08 +00: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 20:42:36 +00:00
</constants>
doc: Sync classref with current source
2017-12-09 23:43:30 +00:00
</class>