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

3881 lines
174 KiB
XML
Raw Normal View History

Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<?xml version="1.0" encoding="UTF-8" ?>
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-03-16 23:01:02 +01:00
<class name="VisualServer" inherits="Object" version="3.5" 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 22:42:36 +02:00
<brief_description>
Server for anything visible.
</brief_description>
<description>
Server for anything visible. The visual server is the API backend for everything visible. The whole scene system mounts on it to display.
The visual server is completely opaque, the internals are entirely implementation specific and cannot be accessed.
Finish documenting VisualServer
2020-01-06 00:36:50 +01:00
The visual server can be used to bypass the scene system entirely.
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].
In 3D, all visual objects must be associated with a scenario. The scenario is a visual representation of the world. If accessing the visual server from a running game, the scenario can be accessed from the scene tree from any [Spatial] node with [method Spatial.get_world]. Otherwise, a scenario can be created with [method scenario_create].
class reference proofreading (cherry picked from commit 8455e901f39c90d581aeb8913640219fb8754e77)
2021-03-18 12:04:28 +01:00
Similarly, in 2D, a canvas is needed to draw all canvas items.
Finish documenting VisualServer
2020-01-06 00:36:50 +01:00
In 3D, all visible objects are comprised of a resource and an instance. A resource can be a mesh, a particle system, a light, or any other 3D object. In order to be visible resources must be attached to an instance using [method instance_set_base]. The instance must also be attached to the scenario using [method instance_set_scenario] in order to be visible.
In 2D, all visible objects are some form of canvas item. In order to be visible, a canvas item needs to be the child of a canvas attached to a viewport, or it needs to be the child of another canvas item that is eventually attached to the canvas.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</description>
<tutorials>
Fix broken links in Class Reference
2021-12-10 11:29:38 +01:00
<link>$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 22:42:36 +02:00
</tutorials>
<methods>
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<method name="black_bars_set_images">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="left" type="RID" />
<argument index="1" name="top" type="RID" />
<argument index="2" name="right" type="RID" />
<argument index="3" name="bottom" type="RID" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Sets images to be rendered in the window margin.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
<method name="black_bars_set_margins">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="left" type="int" />
<argument index="1" name="top" type="int" />
<argument index="2" name="right" type="int" />
<argument index="3" name="bottom" type="int" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Sets margin size, where black bars (or images, if [method black_bars_set_images] was used) are rendered.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<method name="camera_create">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="RID" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Updated docs for many VisualServer methods
2019-12-15 01:38:19 +01:00
Creates a camera and adds it to the VisualServer. It can be accessed with the RID that is returned. This RID will be used in all [code]camera_*[/code] VisualServer functions.
Updated many VisualServer functions
2020-01-04 08:24:40 +01:00
Once finished with your RID, you will want to free the RID using the VisualServer's [method free_rid] static method.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="camera" type="RID" />
<argument index="1" name="layers" type="int" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
doc: Misc updates for AnimationNode* and others - Add some missing descriptions. - Add links to tutorials for ARVR and AnimationTree. - Style fixes. - Engine changes: * Make `AnimationNodeTransition.input_<number>` properties internal so that they don't appear in the docs. They still appear in the inspector based on the actual number of inputs requested. * Drop unimplemented `CPUParticles.flatness`. It's only used for 3D particles in `ParticlesMaterial`, and thus only relevant for `CPUParticles3D`.
2020-01-23 11:14:14 +01:00
Sets the cull mask associated with this camera. The cull mask describes which 3D layers are rendered by this camera. Equivalent to [member Camera.cull_mask].
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
<method name="camera_set_environment">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="camera" type="RID" />
<argument index="1" name="env" type="RID" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Updated docs for many VisualServer methods
2019-12-15 01:38:19 +01:00
Sets the environment used by this camera. Equivalent to [member Camera.environment].
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
Added inspector plugin documentation. Fixed plugin bindings.
2019-04-23 21:39:09 +02:00
<method name="camera_set_frustum">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="camera" type="RID" />
<argument index="1" name="size" type="float" />
<argument index="2" name="offset" type="Vector2" />
<argument index="3" name="z_near" type="float" />
<argument index="4" name="z_far" type="float" />
Added inspector plugin documentation. Fixed plugin bindings.
2019-04-23 21:39:09 +02:00
<description>
Updated docs for many VisualServer methods
2019-12-15 01:38:19 +01:00
Sets camera to use frustum projection. This mode allows adjusting the [code]offset[/code] argument to create "tilted frustum" effects.
Added inspector plugin documentation. Fixed plugin bindings.
2019-04-23 21:39:09 +02:00
</description>
</method>
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<method name="camera_set_orthogonal">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="camera" type="RID" />
<argument index="1" name="size" type="float" />
<argument index="2" name="z_near" type="float" />
<argument index="3" name="z_far" type="float" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Updated docs for many VisualServer methods
2019-12-15 01:38:19 +01:00
Sets camera to use orthogonal projection, also known as orthographic projection. Objects remain the same size on the screen no matter how far away they are.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
<method name="camera_set_perspective">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="camera" type="RID" />
<argument index="1" name="fovy_degrees" type="float" />
<argument index="2" name="z_near" type="float" />
<argument index="3" name="z_far" type="float" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Updated docs for many VisualServer methods
2019-12-15 01:38:19 +01:00
Sets camera to use perspective projection. Objects on the screen becomes smaller when they are far away.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
<method name="camera_set_transform">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="camera" type="RID" />
<argument index="1" name="transform" type="Transform" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Updated docs for many VisualServer methods
2019-12-15 01:38:19 +01:00
Sets [Transform] of camera.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
<method name="camera_set_use_vertical_aspect">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="camera" type="RID" />
<argument index="1" name="enable" type="bool" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Updated docs for many VisualServer methods
2019-12-15 01:38:19 +01:00
If [code]true[/code], preserves the horizontal aspect ratio which is equivalent to [constant Camera.KEEP_WIDTH]. If [code]false[/code], preserves the vertical aspect ratio which is equivalent to [constant Camera.KEEP_HEIGHT].
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<method name="canvas_create">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="RID" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Updated many VisualServer functions
2020-01-04 08:24:40 +01: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] VisualServer functions.
Once finished with your RID, you will want to free the RID using the VisualServer's [method free_rid] static method.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
<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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="item" type="RID" />
<argument index="1" name="pos" type="Vector2" />
<argument index="2" name="radius" type="float" />
<argument index="3" name="color" type="Color" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Adds a circle command to the [CanvasItem]'s draw commands.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
<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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="item" type="RID" />
<argument index="1" name="ignore" type="bool" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
If ignore is [code]true[/code], the VisualServer does not perform clipping.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
<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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="item" type="RID" />
<argument index="1" name="from" type="Vector2" />
<argument index="2" name="to" type="Vector2" />
<argument index="3" name="color" type="Color" />
<argument index="4" name="width" type="float" default="1.0" />
<argument index="5" name="antialiased" type="bool" default="false" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Adds a line command to the [CanvasItem]'s draw commands.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
<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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="item" type="RID" />
<argument index="1" name="mesh" type="RID" />
<argument index="2" name="transform" type="Transform2D" default="Transform2D( 1, 0, 0, 1, 0, 0 )" />
<argument index="3" name="modulate" type="Color" default="Color( 1, 1, 1, 1 )" />
<argument index="4" name="texture" type="RID" />
<argument index="5" name="normal_map" type="RID" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Updated docs for many VisualServer methods
2019-12-15 01:38:19 +01:00
Adds a mesh command to the [CanvasItem]'s draw commands.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
<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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="item" type="RID" />
<argument index="1" name="mesh" type="RID" />
<argument index="2" name="texture" type="RID" />
<argument index="3" name="normal_map" type="RID" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Adds a [MultiMesh] to the [CanvasItem]'s draw commands. Only affects its aabb at the moment.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
<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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="item" type="RID" />
<argument index="1" name="rect" type="Rect2" />
<argument index="2" name="source" type="Rect2" />
<argument index="3" name="texture" type="RID" />
<argument index="4" name="topleft" type="Vector2" />
<argument index="5" name="bottomright" type="Vector2" />
<argument index="6" name="x_axis_mode" type="int" enum="VisualServer.NinePatchAxisMode" default="0" />
<argument index="7" name="y_axis_mode" type="int" enum="VisualServer.NinePatchAxisMode" default="0" />
<argument index="8" name="draw_center" type="bool" default="true" />
<argument index="9" name="modulate" type="Color" default="Color( 1, 1, 1, 1 )" />
<argument index="10" name="normal_map" type="RID" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Adds a nine patch image to the [CanvasItem]'s draw commands.
See [NinePatchRect] for more explanation.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
<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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="item" type="RID" />
<argument index="1" name="particles" type="RID" />
<argument index="2" name="texture" type="RID" />
<argument index="3" name="normal_map" type="RID" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-22 01:04:47 +02:00
Adds a particle system to the [CanvasItem]'s draw commands.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
<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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="item" type="RID" />
<argument index="1" name="points" type="PoolVector2Array" />
<argument index="2" name="colors" type="PoolColorArray" />
<argument index="3" name="uvs" type="PoolVector2Array" default="PoolVector2Array( )" />
<argument index="4" name="texture" type="RID" />
<argument index="5" name="normal_map" type="RID" />
<argument index="6" name="antialiased" type="bool" default="false" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Adds a polygon to the [CanvasItem]'s draw commands.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
<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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="item" type="RID" />
<argument index="1" name="points" type="PoolVector2Array" />
<argument index="2" name="colors" type="PoolColorArray" />
<argument index="3" name="width" type="float" default="1.0" />
<argument index="4" name="antialiased" type="bool" default="false" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Fix typos in code and docs with codespell Using v1.11.0 from https://github.com/lucasdemarchi/codespell
2018-01-18 21:37:17 +01:00
Adds a polyline, which is a line from multiple points with a width, to the [CanvasItem]'s draw commands.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
<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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="item" type="RID" />
<argument index="1" name="points" type="PoolVector2Array" />
<argument index="2" name="colors" type="PoolColorArray" />
<argument index="3" name="uvs" type="PoolVector2Array" />
<argument index="4" name="texture" type="RID" />
<argument index="5" name="width" type="float" default="1.0" />
<argument index="6" name="normal_map" type="RID" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Adds a primitive to the [CanvasItem]'s draw commands.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
<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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="item" type="RID" />
<argument index="1" name="rect" type="Rect2" />
<argument index="2" name="color" type="Color" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Adds a rectangle to the [CanvasItem]'s draw commands.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
<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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="item" type="RID" />
<argument index="1" name="transform" type="Transform2D" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Adds a [Transform2D] command to the [CanvasItem]'s draw commands.
Fixes a typo in the VisualServer.canvas_item_add_set_transform docs.
2018-04-21 16:10:34 +02:00
This sets the extra_matrix uniform when executed. This affects the later commands of the canvas item.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
<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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="item" type="RID" />
<argument index="1" name="rect" type="Rect2" />
<argument index="2" name="texture" type="RID" />
<argument index="3" name="tile" type="bool" default="false" />
<argument index="4" name="modulate" type="Color" default="Color( 1, 1, 1, 1 )" />
<argument index="5" name="transpose" type="bool" default="false" />
<argument index="6" name="normal_map" type="RID" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Adds a textured rect to the [CanvasItem]'s draw commands.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
<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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="item" type="RID" />
<argument index="1" name="rect" type="Rect2" />
<argument index="2" name="texture" type="RID" />
<argument index="3" name="src_rect" type="Rect2" />
<argument index="4" name="modulate" type="Color" default="Color( 1, 1, 1, 1 )" />
<argument index="5" name="transpose" type="bool" default="false" />
<argument index="6" name="normal_map" type="RID" />
<argument index="7" name="clip_uv" type="bool" default="true" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Adds a texture rect with region setting to the [CanvasItem]'s draw commands.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
<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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="item" type="RID" />
<argument index="1" name="indices" type="PoolIntArray" />
<argument index="2" name="points" type="PoolVector2Array" />
<argument index="3" name="colors" type="PoolColorArray" />
<argument index="4" name="uvs" type="PoolVector2Array" default="PoolVector2Array( )" />
<argument index="5" name="bones" type="PoolIntArray" default="PoolIntArray( )" />
<argument index="6" name="weights" type="PoolRealArray" default="PoolRealArray( )" />
<argument index="7" name="texture" type="RID" />
<argument index="8" name="count" type="int" default="-1" />
<argument index="9" name="normal_map" type="RID" />
<argument index="10" name="antialiased" type="bool" default="false" />
<argument index="11" name="antialiasing_use_indices" type="bool" default="false" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Updated docs for many VisualServer methods
2019-12-15 01:38:19 +01:00
Adds a triangle array to the [CanvasItem]'s draw commands.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
<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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="item" type="RID" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Clears the [CanvasItem] and removes all commands in it.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
<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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="RID" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Updated many VisualServer functions
2020-01-04 08:24:40 +01:00
Creates a new [CanvasItem] and returns its [RID]. It can be accessed with the RID that is returned. This RID will be used in all [code]canvas_item_*[/code] VisualServer functions.
Once finished with your RID, you will want to free the RID using the VisualServer's [method free_rid] static method.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
<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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="item" type="RID" />
<argument index="1" name="clip" type="bool" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Sets clipping for the [CanvasItem].
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
<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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="item" type="RID" />
<argument index="1" name="enabled" type="bool" />
<argument index="2" name="rect" type="Rect2" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Sets the [CanvasItem] to copy a rect to the backbuffer.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
<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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="item" type="RID" />
<argument index="1" name="use_custom_rect" type="bool" />
<argument index="2" name="rect" type="Rect2" default="Rect2( 0, 0, 0, 0 )" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Defines a custom drawing rectangle for the [CanvasItem].
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
<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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="item" type="RID" />
<argument index="1" name="enabled" type="bool" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Updated docs for many VisualServer methods
2019-12-15 01:38:19 +01:00
Enables the use of distance fields for GUI elements that are rendering distance field based fonts.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
<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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="item" type="RID" />
<argument index="1" name="enabled" type="bool" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Sets [CanvasItem] to be drawn behind its parent.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
<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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="item" type="RID" />
<argument index="1" name="index" type="int" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Sets the index for the [CanvasItem].
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
<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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="item" type="RID" />
<argument index="1" name="mask" type="int" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
The light mask. See [LightOccluder2D] for more information on light masks.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
<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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="item" type="RID" />
<argument index="1" name="material" type="RID" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Sets a new material to the [CanvasItem].
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
<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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="item" type="RID" />
<argument index="1" name="color" type="Color" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Sets the color that modulates the [CanvasItem] and its children.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
<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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="item" type="RID" />
<argument index="1" name="parent" type="RID" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Finish documenting VisualServer
2020-01-06 00:36:50 +01:00
Sets the parent for the [CanvasItem]. The parent can be another canvas item, or it can be the root canvas that is attached to the viewport.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
<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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="item" type="RID" />
<argument index="1" name="color" type="Color" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Sets the color that modulates the [CanvasItem] without children.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="item" type="RID" />
<argument index="1" name="enabled" type="bool" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Sets if [CanvasItem]'s children should be sorted by y-position.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
<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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="item" type="RID" />
<argument index="1" name="transform" type="Transform2D" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Sets the [CanvasItem]'s [Transform2D].
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
<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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="item" type="RID" />
<argument index="1" name="enabled" type="bool" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Sets if the [CanvasItem] uses its parent's material.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
<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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="item" type="RID" />
<argument index="1" name="visible" type="bool" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Sets if the canvas item (including its children) is visible.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
doc: Sync classref with current source
2018-01-04 01:48:24 +01:00
<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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="item" type="RID" />
<argument index="1" name="enabled" type="bool" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-22 01:04:47 +02:00
If this is enabled, the Z index of the parent will be added to the children's Z index.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
doc: Sync classref with current source
2018-01-04 01:48:24 +01: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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="item" type="RID" />
<argument index="1" name="z_index" type="int" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-22 01:04:47 +02:00
Sets the [CanvasItem]'s Z index, i.e. its draw order (lower indexes are drawn first).
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
<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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="light" type="RID" />
<argument index="1" name="canvas" type="RID" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Attaches the canvas light to the canvas. Removes it from its previous canvas.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
<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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="RID" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Updated many VisualServer functions
2020-01-04 08:24:40 +01:00
Creates a canvas light and adds it to the VisualServer. It can be accessed with the RID that is returned. This RID will be used in all [code]canvas_light_*[/code] VisualServer functions.
Once finished with your RID, you will want to free the RID using the VisualServer's [method free_rid] static method.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
<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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="occluder" type="RID" />
<argument index="1" name="canvas" type="RID" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Attaches a light occluder to the canvas. Removes it from its previous canvas.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="RID" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Updated many VisualServer functions
2020-01-04 08:24:40 +01:00
Creates a light occluder and adds it to the VisualServer. It can be accessed with the RID that is returned. This RID will be used in all [code]canvas_light_ocluder_*[/code] VisualServer functions.
Once finished with your RID, you will want to free the RID using the VisualServer's [method free_rid] static method.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
<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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="occluder" type="RID" />
<argument index="1" name="enabled" type="bool" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Enables or disables light occluder.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
<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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="occluder" type="RID" />
<argument index="1" name="mask" type="int" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-22 01:04:47 +02:00
The light mask. See [LightOccluder2D] for more information on light masks.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
<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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="occluder" type="RID" />
<argument index="1" name="polygon" type="RID" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Sets a light occluder's polygon.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
<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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="occluder" type="RID" />
<argument index="1" name="transform" type="Transform2D" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Sets a light occluder's [Transform2D].
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
<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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="light" type="RID" />
<argument index="1" name="color" type="Color" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Sets the color for a light.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
<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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="light" type="RID" />
<argument index="1" name="enabled" type="bool" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Enables or disables a canvas light.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
<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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="light" type="RID" />
<argument index="1" name="energy" type="float" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Sets a canvas light's energy.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
<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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="light" type="RID" />
<argument index="1" name="height" type="float" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
doc: Sync classref with current source
2017-12-10 00:43:30 +01:00
Sets a canvas light's height.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
<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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="light" type="RID" />
<argument index="1" name="mask" type="int" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-22 01:04:47 +02:00
The light mask. See [LightOccluder2D] for more information on light masks.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
<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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="light" type="RID" />
<argument index="1" name="mask" type="int" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-22 01:04:47 +02:00
The binary mask used to determine which layers this canvas light's shadows affects. See [LightOccluder2D] for more information on light masks.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
<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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="light" type="RID" />
<argument index="1" name="min_layer" type="int" />
<argument index="2" name="max_layer" type="int" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
The layer range that gets rendered with this light.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
<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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="light" type="RID" />
<argument index="1" name="mode" type="int" enum="VisualServer.CanvasLightMode" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
doc: Markup fixes for enums and constants
2019-12-06 23:09:20 +01:00
The mode of the light, see [enum CanvasLightMode] constants.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
<method name="canvas_light_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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="light" type="RID" />
<argument index="1" name="scale" type="float" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Updated docs for many VisualServer methods
2019-12-15 01:38:19 +01:00
Sets the texture's scale factor of the light. Equivalent to [member Light2D.texture_scale].
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
<method name="canvas_light_set_shadow_buffer_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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="light" type="RID" />
<argument index="1" name="size" type="int" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Sets the width of the shadow buffer, size gets scaled to the next power of two for this.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
<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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="light" type="RID" />
<argument index="1" name="color" type="Color" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Sets the color of the canvas light's shadow.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="light" type="RID" />
<argument index="1" name="enabled" type="bool" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Enables or disables the canvas light's shadow.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
<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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="light" type="RID" />
<argument index="1" name="filter" type="int" enum="VisualServer.CanvasLightShadowFilter" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
doc: Markup fixes for enums and constants
2019-12-06 23:09:20 +01:00
Sets the canvas light's shadow's filter, see [enum CanvasLightShadowFilter] constants.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
<method name="canvas_light_set_shadow_gradient_length">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="light" type="RID" />
<argument index="1" name="length" type="float" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Sets the length of the shadow's gradient.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
<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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="light" type="RID" />
<argument index="1" name="smooth" type="float" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-22 01:04:47 +02:00
Smoothens the shadow. The lower, the smoother.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
<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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="light" type="RID" />
<argument index="1" name="texture" type="RID" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Updated docs for many VisualServer methods
2019-12-15 01:38:19 +01:00
Sets texture to be used by light. Equivalent to [member Light2D.texture].
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
<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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="light" type="RID" />
<argument index="1" name="offset" type="Vector2" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Updated docs for many VisualServer methods
2019-12-15 01:38:19 +01:00
Sets the offset of the light's texture. Equivalent to [member Light2D.offset].
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
<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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="light" type="RID" />
<argument index="1" name="transform" type="Transform2D" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Sets the canvas light's [Transform2D].
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
<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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="light" type="RID" />
<argument index="1" name="min_z" type="int" />
<argument index="2" name="max_z" type="int" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Updated docs for many VisualServer methods
2019-12-15 01:38:19 +01: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].
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
<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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="RID" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Updated many VisualServer functions
2020-01-04 08:24:40 +01:00
Creates a new light occluder polygon and adds it to the VisualServer. It can be accessed with the RID that is returned. This RID will be used in all [code]canvas_occluder_polygon_*[/code] VisualServer functions.
Once finished with your RID, you will want to free the RID using the VisualServer's [method free_rid] static method.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
<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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="occluder_polygon" type="RID" />
<argument index="1" name="mode" type="int" enum="VisualServer.CanvasOccluderPolygonCullMode" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
doc: Markup fixes for enums and constants
2019-12-06 23:09:20 +01:00
Sets an occluder polygons cull mode. See [enum CanvasOccluderPolygonCullMode] constants.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
<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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="occluder_polygon" type="RID" />
<argument index="1" name="shape" type="PoolVector2Array" />
<argument index="2" name="closed" type="bool" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Sets the shape of the occluder polygon.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
<method name="canvas_occluder_polygon_set_shape_as_lines">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="occluder_polygon" type="RID" />
<argument index="1" name="shape" type="PoolVector2Array" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Sets the shape of the occluder polygon as lines.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
<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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="canvas" type="RID" />
<argument index="1" name="item" type="RID" />
<argument index="2" name="mirroring" type="Vector2" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
A copy of the canvas item will be drawn with a local offset of the mirroring [Vector2].
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
<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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="canvas" type="RID" />
<argument index="1" name="color" type="Color" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Modulates all colors in the given canvas.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
doc: Sync classref with current source
2018-02-19 10:47:16 +01: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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="RID" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Updated docs for many VisualServer methods
2019-12-15 01:38:19 +01:00
Creates a directional light and adds it to the VisualServer. It can be accessed with the RID that is returned. This RID can be used in most [code]light_*[/code] VisualServer functions.
Updated many VisualServer functions
2020-01-04 08:24:40 +01:00
Once finished with your RID, you will want to free the RID using the VisualServer'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.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<method name="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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="swap_buffers" type="bool" default="true" />
<argument index="1" name="frame_step" type="float" default="0.0" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Updated docs for many VisualServer methods
2019-12-15 01:38:19 +01:00
Draws a frame. [i]This method is deprecated[/i], please use [method force_draw] instead.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="RID" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Updated docs for many VisualServer methods
2019-12-15 01:38:19 +01:00
Creates an environment and adds it to the VisualServer. It can be accessed with the RID that is returned. This RID will be used in all [code]environment_*[/code] VisualServer functions.
Updated many VisualServer functions
2020-01-04 08:24:40 +01:00
Once finished with your RID, you will want to free the RID using the VisualServer's [method free_rid] static method.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="env" type="RID" />
<argument index="1" name="enable" type="bool" />
<argument index="2" name="brightness" type="float" />
<argument index="3" name="contrast" type="float" />
<argument index="4" name="saturation" type="float" />
<argument index="5" name="ramp" type="RID" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<description>
Updated docs for many VisualServer methods
2019-12-15 01:38:19 +01:00
Sets the values to be used with the "Adjustment" post-process effect. See [Environment] for more details.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</description>
</method>
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="env" type="RID" />
<argument index="1" name="color" type="Color" />
<argument index="2" name="energy" type="float" default="1.0" />
<argument index="3" name="sky_contibution" type="float" default="0.0" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Updated docs for many VisualServer methods
2019-12-15 01:38:19 +01:00
Sets the ambient light parameters. See [Environment] for more details.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="env" type="RID" />
<argument index="1" name="bg" type="int" enum="VisualServer.EnvironmentBG" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Updated docs for many VisualServer methods
2019-12-15 01:38:19 +01:00
Sets the [i]BGMode[/i] of the environment. Equivalent to [member Environment.background_mode].
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="env" type="RID" />
<argument index="1" name="color" type="Color" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Updated docs for many VisualServer methods
2019-12-15 01:38:19 +01:00
Color displayed for clear areas of the scene (if using Custom color or Color+Sky background modes).
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="env" type="RID" />
<argument index="1" name="energy" type="float" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Updated docs for many VisualServer methods
2019-12-15 01:38:19 +01:00
Sets the intensity of the background color.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="env" type="RID" />
<argument index="1" name="max_layer" type="int" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Updated docs for many VisualServer methods
2019-12-15 01:38:19 +01:00
Sets the maximum layer to use if using Canvas background mode.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<method name="environment_set_dof_blur_far">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="env" type="RID" />
<argument index="1" name="enable" type="bool" />
<argument index="2" name="distance" type="float" />
<argument index="3" name="transition" type="float" />
<argument index="4" name="far_amount" type="float" />
<argument index="5" name="quality" type="int" enum="VisualServer.EnvironmentDOFBlurQuality" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Updated docs for many VisualServer methods
2019-12-15 01:38:19 +01:00
Sets the values to be used with the "DoF Far Blur" post-process effect. See [Environment] for more details.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<method name="environment_set_dof_blur_near">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="env" type="RID" />
<argument index="1" name="enable" type="bool" />
<argument index="2" name="distance" type="float" />
<argument index="3" name="transition" type="float" />
<argument index="4" name="far_amount" type="float" />
<argument index="5" name="quality" type="int" enum="VisualServer.EnvironmentDOFBlurQuality" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Updated docs for many VisualServer methods
2019-12-15 01:38:19 +01:00
Sets the values to be used with the "DoF Near Blur" post-process effect. See [Environment] for more details.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="env" type="RID" />
<argument index="1" name="enable" type="bool" />
<argument index="2" name="color" type="Color" />
<argument index="3" name="sun_color" type="Color" />
<argument index="4" name="sun_amount" type="float" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Updated docs for many VisualServer methods
2019-12-15 01:38:19 +01:00
Sets the variables to be used with the scene fog. See [Environment] for more details.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<method name="environment_set_fog_depth">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="env" type="RID" />
<argument index="1" name="enable" type="bool" />
<argument index="2" name="depth_begin" type="float" />
<argument index="3" name="depth_end" type="float" />
<argument index="4" name="depth_curve" type="float" />
<argument index="5" name="transmit" type="bool" />
<argument index="6" name="transmit_curve" type="float" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Updated docs for many VisualServer methods
2019-12-15 01:38:19 +01:00
Sets the variables to be used with the fog depth effect. See [Environment] for more details.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<method name="environment_set_fog_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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="env" type="RID" />
<argument index="1" name="enable" type="bool" />
<argument index="2" name="min_height" type="float" />
<argument index="3" name="max_height" type="float" />
<argument index="4" name="height_curve" type="float" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Updated docs for many VisualServer methods
2019-12-15 01:38:19 +01:00
Sets the variables to be used with the fog height effect. See [Environment] for more details.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="env" type="RID" />
<argument index="1" name="enable" type="bool" />
<argument index="2" name="level_flags" type="int" />
<argument index="3" name="intensity" type="float" />
<argument index="4" name="strength" type="float" />
<argument index="5" name="bloom_threshold" type="float" />
<argument index="6" name="blend_mode" type="int" enum="VisualServer.EnvironmentGlowBlendMode" />
<argument index="7" name="hdr_bleed_threshold" type="float" />
<argument index="8" name="hdr_bleed_scale" type="float" />
<argument index="9" name="hdr_luminance_cap" type="float" />
<argument index="10" name="bicubic_upscale" type="bool" />
Add high quality glow mode This backports the high quality glow mode from the `master` branch. Previously, during downsample, every second row was ignored. Now, when high-quality is used, we sample two rows at once to ensure that no pixel is missed. It is slower, but looks much better and has a much high stability while moving. High quality also takes an additional horizontal sample the width of the horizontal blur matches the height of the vertical blur.
2021-08-11 04:42:56 +02:00
<argument index="11" name="high_quality" type="bool" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Updated docs for many VisualServer methods
2019-12-15 01:38:19 +01:00
Sets the variables to be used with the "glow" post-process effect. See [Environment] for more details.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="env" type="RID" />
<argument index="1" name="sky" type="RID" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Updated docs for many VisualServer methods
2019-12-15 01:38:19 +01:00
Sets the [Sky] to be used as the environment's background when using [i]BGMode[/i] sky. Equivalent to [member Environment.background_sky].
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="env" type="RID" />
<argument index="1" name="scale" type="float" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Updated docs for many VisualServer methods
2019-12-15 01:38:19 +01:00
Sets a custom field of view for the background [Sky]. Equivalent to [member Environment.background_sky_custom_fov].
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
doc: Sync classref with current source Fix various code formatting issues and argument names.
2018-12-27 11:10:09 +01:00
<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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="env" type="RID" />
<argument index="1" name="orientation" type="Basis" />
doc: Sync classref with current source Fix various code formatting issues and argument names.
2018-12-27 11:10:09 +01:00
<description>
Updated docs for many VisualServer methods
2019-12-15 01:38:19 +01:00
Sets the rotation of the background [Sky] expressed as a [Basis]. Equivalent to [member Environment.background_sky_orientation].
doc: Sync classref with current source Fix various code formatting issues and argument names.
2018-12-27 11:10:09 +01:00
</description>
</method>
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="env" type="RID" />
<argument index="1" name="enable" type="bool" />
<argument index="2" name="radius" type="float" />
<argument index="3" name="intensity" type="float" />
<argument index="4" name="radius2" type="float" />
<argument index="5" name="intensity2" type="float" />
<argument index="6" name="bias" type="float" />
<argument index="7" name="light_affect" type="float" />
<argument index="8" name="ao_channel_affect" type="float" />
<argument index="9" name="color" type="Color" />
<argument index="10" name="quality" type="int" enum="VisualServer.EnvironmentSSAOQuality" />
<argument index="11" name="blur" type="int" enum="VisualServer.EnvironmentSSAOBlur" />
<argument index="12" name="bilateral_sharpness" type="float" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Updated docs for many VisualServer methods
2019-12-15 01:38:19 +01:00
Sets the variables to be used with the "Screen Space Ambient Occlusion (SSAO)" post-process effect. See [Environment] for more details.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="env" type="RID" />
<argument index="1" name="enable" type="bool" />
<argument index="2" name="max_steps" type="int" />
<argument index="3" name="fade_in" type="float" />
<argument index="4" name="fade_out" type="float" />
<argument index="5" name="depth_tolerance" type="float" />
<argument index="6" name="roughness" type="bool" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Updated docs for many VisualServer methods
2019-12-15 01:38:19 +01:00
Sets the variables to be used with the "screen space reflections" post-process effect. See [Environment] for more details.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="env" type="RID" />
<argument index="1" name="tone_mapper" type="int" enum="VisualServer.EnvironmentToneMapper" />
<argument index="2" name="exposure" type="float" />
<argument index="3" name="white" type="float" />
<argument index="4" name="auto_exposure" type="bool" />
<argument index="5" name="min_luminance" type="float" />
<argument index="6" name="max_luminance" type="float" />
<argument index="7" name="auto_exp_speed" type="float" />
<argument index="8" name="auto_exp_grey" type="float" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Updated docs for many VisualServer methods
2019-12-15 01:38:19 +01:00
Sets the variables to be used with the "tonemap" post-process effect. See [Environment] for more details.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<method name="finish">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Removes buffers and clears testcubes.
</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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="swap_buffers" type="bool" default="true" />
<argument index="1" name="frame_step" type="float" default="0.0" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Updated docs for many VisualServer methods
2019-12-15 01:38:19 +01:00
Forces a frame to be drawn when the function is called. Drawing a frame updates all [Viewport]s that are set to update. Use with extreme caution.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Fix typos with codespell Found via `codespell -q 3 --skip="./thirdparty,./editor/translations" -I ../godot-word-whitelist.txt` Whitelist consists of: ``` ang doubleclick lod nd que te unselect ```
2018-02-21 17:30:55 +01:00
Synchronizes threads.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="rid" type="RID" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Tries to free an object in the VisualServer.
</description>
</method>
<method name="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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="int" />
<argument index="0" name="info" type="int" enum="VisualServer.RenderInfo" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
doc: Markup fixes for enums and constants
2019-12-06 23:09:20 +01:00
Returns a certain information, see [enum RenderInfo] for options.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
<method name="get_test_cube">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="RID" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Returns the id of the test cube. Creates one if none exists.
</description>
</method>
<method name="get_test_texture">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="RID" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Returns the id of the test texture. Creates one if none exists.
</description>
</method>
Add VisualServer methods to get the video adapter name and vendor These methods can be used in scripts to retrieve the OpenGL `GL_RENDERER` and `GL_VENDOR` strings (respectively). This closes #28404.
2019-09-13 20:08:05 +02: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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="String" />
Add VisualServer methods to get the video adapter name and vendor These methods can be used in scripts to retrieve the OpenGL `GL_RENDERER` and `GL_VENDOR` strings (respectively). This closes #28404.
2019-09-13 20:08:05 +02:00
<description>
Returns the name of the video adapter (e.g. "GeForce GTX 1080/PCIe/SSE2").
[b]Note:[/b] When running a headless or server binary, this function returns an empty string.
</description>
</method>
<method name="get_video_adapter_vendor" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="String" />
Add VisualServer methods to get the video adapter name and vendor These methods can be used in scripts to retrieve the OpenGL `GL_RENDERER` and `GL_VENDOR` strings (respectively). This closes #28404.
2019-09-13 20:08:05 +02:00
<description>
Returns the vendor of the video adapter (e.g. "NVIDIA Corporation").
[b]Note:[/b] When running a headless or server binary, this function returns an empty string.
</description>
</method>
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="RID" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Returns the id of a white texture. Creates one if none exists.
</description>
</method>
<method name="gi_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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="RID" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Updated many VisualServer functions
2020-01-04 08:24:40 +01:00
Creates a GI probe and adds it to the VisualServer. It can be accessed with the RID that is returned. This RID will be used in all [code]gi_probe_*[/code] VisualServer functions.
Once finished with your RID, you will want to free the RID using the VisualServer's [method free_rid] static method.
To place in a scene, attach this GI probe to an instance using [method instance_set_base] using the returned RID.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
<method name="gi_probe_get_bias" 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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="float" />
<argument index="0" name="probe" type="RID" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Document most VisualServer functions
2020-01-05 09:33:16 +01:00
Returns the bias value for the GI probe. Bias is used to avoid self occlusion. Equivalent to [member GIProbeData.bias].
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
<method name="gi_probe_get_bounds" 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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="AABB" />
<argument index="0" name="probe" type="RID" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Document most VisualServer functions
2020-01-05 09:33:16 +01:00
Returns the axis-aligned bounding box that covers the full extent of the GI probe.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
<method name="gi_probe_get_cell_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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="float" />
<argument index="0" name="probe" type="RID" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Document most VisualServer functions
2020-01-05 09:33:16 +01:00
Returns the cell size set by [method gi_probe_set_cell_size].
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
<method name="gi_probe_get_dynamic_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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="PoolIntArray" />
<argument index="0" name="probe" type="RID" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Document most VisualServer functions
2020-01-05 09:33:16 +01:00
Returns the data used by the GI probe.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
<method name="gi_probe_get_dynamic_range" 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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="int" />
<argument index="0" name="probe" type="RID" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Document most VisualServer functions
2020-01-05 09:33:16 +01:00
Returns the dynamic range set for this GI probe. Equivalent to [member GIProbe.dynamic_range].
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
<method name="gi_probe_get_energy" 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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="float" />
<argument index="0" name="probe" type="RID" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Document most VisualServer functions
2020-01-05 09:33:16 +01:00
Returns the energy multiplier for this GI probe. Equivalent to [member GIProbe.energy].
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
<method name="gi_probe_get_normal_bias" 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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="float" />
<argument index="0" name="probe" type="RID" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Document most VisualServer functions
2020-01-05 09:33:16 +01:00
Returns the normal bias for this GI probe. Equivalent to [member GIProbe.normal_bias].
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
<method name="gi_probe_get_propagation" 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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="float" />
<argument index="0" name="probe" type="RID" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Document most VisualServer functions
2020-01-05 09:33:16 +01:00
Returns the propagation value for this GI probe. Equivalent to [member GIProbe.propagation].
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
<method name="gi_probe_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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="Transform" />
<argument index="0" name="probe" type="RID" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Document most VisualServer functions
2020-01-05 09:33:16 +01:00
Returns the Transform set by [method gi_probe_set_to_cell_xform].
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
<method name="gi_probe_is_compressed" 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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="bool" />
<argument index="0" name="probe" type="RID" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Document most VisualServer functions
2020-01-05 09:33:16 +01:00
Returns [code]true[/code] if the GI probe data associated with this GI probe is compressed. Equivalent to [member GIProbe.compress].
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
<method name="gi_probe_is_interior" 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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="bool" />
<argument index="0" name="probe" type="RID" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Document most VisualServer functions
2020-01-05 09:33:16 +01:00
Returns [code]true[/code] if the GI probe is set to interior, meaning it does not account for sky light. Equivalent to [member GIProbe.interior].
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
<method name="gi_probe_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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="probe" type="RID" />
<argument index="1" name="bias" type="float" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Document most VisualServer functions
2020-01-05 09:33:16 +01:00
Sets the bias value to avoid self-occlusion. Equivalent to [member GIProbe.bias].
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
<method name="gi_probe_set_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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="probe" type="RID" />
<argument index="1" name="bounds" type="AABB" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Document most VisualServer functions
2020-01-05 09:33:16 +01:00
Sets the axis-aligned bounding box that covers the extent of the GI probe.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
<method name="gi_probe_set_cell_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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="probe" type="RID" />
<argument index="1" name="range" type="float" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Document most VisualServer functions
2020-01-05 09:33:16 +01:00
Sets the size of individual cells within the GI probe.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
<method name="gi_probe_set_compress">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="probe" type="RID" />
<argument index="1" name="enable" type="bool" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Document most VisualServer functions
2020-01-05 09:33:16 +01:00
Sets the compression setting for the GI probe data. Compressed data will take up less space but may look worse. Equivalent to [member GIProbe.compress].
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
<method name="gi_probe_set_dynamic_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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="probe" type="RID" />
<argument index="1" name="data" type="PoolIntArray" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Document most VisualServer functions
2020-01-05 09:33:16 +01:00
Sets the data to be used in the GI probe for lighting calculations. Normally this is created and called internally within the [GIProbe] node. You should not try to set this yourself.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
<method name="gi_probe_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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="probe" type="RID" />
<argument index="1" name="range" type="int" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Document most VisualServer functions
2020-01-05 09:33:16 +01:00
Sets the dynamic range of the GI probe. Dynamic range sets the limit for how bright lights can be. A smaller range captures greater detail but limits how bright lights can be. Equivalent to [member GIProbe.dynamic_range].
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
<method name="gi_probe_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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="probe" type="RID" />
<argument index="1" name="energy" type="float" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Document most VisualServer functions
2020-01-05 09:33:16 +01:00
Sets the energy multiplier for this GI probe. A higher energy makes the indirect light from the GI probe brighter. Equivalent to [member GIProbe.energy].
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
<method name="gi_probe_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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="probe" type="RID" />
<argument index="1" name="enable" type="bool" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Document most VisualServer functions
2020-01-05 09:33:16 +01:00
Sets the interior value of this GI probe. A GI probe set to interior does not include the sky when calculating lighting. Equivalent to [member GIProbe.interior].
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
<method name="gi_probe_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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="probe" type="RID" />
<argument index="1" name="bias" type="float" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Document most VisualServer functions
2020-01-05 09:33:16 +01:00
Sets the normal bias for this GI probe. Normal bias behaves similar to the other form of bias and may help reduce self-occlusion. Equivalent to [member GIProbe.normal_bias].
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
<method name="gi_probe_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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="probe" type="RID" />
<argument index="1" name="propagation" type="float" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Document most VisualServer functions
2020-01-05 09:33:16 +01:00
Sets the propagation of light within this GI probe. Equivalent to [member GIProbe.propagation].
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
<method name="gi_probe_set_to_cell_xform">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="probe" type="RID" />
<argument index="1" name="xform" type="Transform" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Document most VisualServer functions
2020-01-05 09:33:16 +01:00
Sets the to cell [Transform] for this GI probe.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="bool" />
Add editor vital redraws only option When editor continuous redraws is switched off, the editor only redraws when a redraw_request was issued by an element in the scene. This works well in most situations, but when scenes have dynamic content they will continuously issue redraw_requests. This can be fine on high power desktops but can be an annoyance on lower power machines. This PR splits redraw requests into high and low priority requests, defaulting to high priority. Requests due to e.g. shaders using TIME are assigned low priority. An extra editor setting is used to record the user preference and an extra option is added to the editor spinner menu, to allow the user to select between 3 modes: * Continuous * Update all changes * Update vital changes
2021-10-05 20:05:57 +02:00
<argument index="0" name="queried_priority" type="int" enum="VisualServer.ChangedPriority" default="0" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Returns [code]true[/code] if changes have been made to the VisualServer's data. [method draw] is usually called if this happens.
Add editor vital redraws only option When editor continuous redraws is switched off, the editor only redraws when a redraw_request was issued by an element in the scene. This works well in most situations, but when scenes have dynamic content they will continuously issue redraw_requests. This can be fine on high power desktops but can be an annoyance on lower power machines. This PR splits redraw requests into high and low priority requests, defaulting to high priority. Requests due to e.g. shaders using TIME are assigned low priority. An extra editor setting is used to record the user preference and an extra option is added to the editor spinner menu, to allow the user to select between 3 modes: * Continuous * Update all changes * Update vital changes
2021-10-05 20:05:57 +02:00
As changes are registered as either high or low priority (e.g. dynamic shaders), this function takes an optional argument to query either low or high priority changes, or any changes.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="bool" />
<argument index="0" name="feature" type="int" enum="VisualServer.Features" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Updated many VisualServer functions
2020-01-04 08:24:40 +01:00
Not yet implemented. Always returns [code]false[/code].
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="bool" />
<argument index="0" name="feature" type="String" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Option for software skinning in MeshInstance Option in MeshInstance to enable software skinning, in order to test against the current USE_SKELETON_SOFTWARE path which causes problems with bad performance. Co-authored-by: lawnjelly <lawnjelly@gmail.com>
2020-07-10 10:25:06 +02:00
Returns [code]true[/code] if the OS supports a certain feature. Features might be [code]s3tc[/code], [code]etc[/code], [code]etc2[/code], [code]pvrtc[/code] and [code]skinning_fallback[/code].
When rendering with GLES2, returns [code]true[/code] with [code]skinning_fallback[/code] in case the hardware doesn't support the default GPU skinning process.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
<method name="immediate_begin">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="immediate" type="RID" />
<argument index="1" name="primitive" type="int" enum="VisualServer.PrimitiveType" />
<argument index="2" name="texture" type="RID" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Updated docs for many VisualServer methods
2019-12-15 01:38:19 +01:00
Sets up [ImmediateGeometry] internals to prepare for drawing. Equivalent to [method ImmediateGeometry.begin].
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
<method name="immediate_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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="immediate" type="RID" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Updated docs for many VisualServer methods
2019-12-15 01:38:19 +01:00
Clears everything that was set up between [method immediate_begin] and [method immediate_end]. Equivalent to [method ImmediateGeometry.clear].
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
<method name="immediate_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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="immediate" type="RID" />
<argument index="1" name="color" type="Color" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Updated docs for many VisualServer methods
2019-12-15 01:38:19 +01:00
Sets the color to be used with next vertex. Equivalent to [method ImmediateGeometry.set_color].
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
<method name="immediate_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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="RID" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Updated many VisualServer functions
2020-01-04 08:24:40 +01:00
Creates an immediate geometry and adds it to the VisualServer. It can be accessed with the RID that is returned. This RID will be used in all [code]immediate_*[/code] VisualServer functions.
Once finished with your RID, you will want to free the RID using the VisualServer's [method free_rid] static method.
To place in a scene, attach this immediate geometry to an instance using [method instance_set_base] using the returned RID.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
<method name="immediate_end">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="immediate" type="RID" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Updated docs for many VisualServer methods
2019-12-15 01:38:19 +01:00
Ends drawing the [ImmediateGeometry] and displays it. Equivalent to [method ImmediateGeometry.end].
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
<method name="immediate_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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="RID" />
<argument index="0" name="immediate" type="RID" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Updated docs for many VisualServer methods
2019-12-15 01:38:19 +01:00
Returns the material assigned to the [ImmediateGeometry].
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
<method name="immediate_normal">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="immediate" type="RID" />
<argument index="1" name="normal" type="Vector3" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Updated docs for many VisualServer methods
2019-12-15 01:38:19 +01:00
Sets the normal to be used with next vertex. Equivalent to [method ImmediateGeometry.set_normal].
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
<method name="immediate_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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="immediate" type="RID" />
<argument index="1" name="material" type="RID" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Updated docs for many VisualServer methods
2019-12-15 01:38:19 +01:00
Sets the material to be used to draw the [ImmediateGeometry].
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
<method name="immediate_tangent">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="immediate" type="RID" />
<argument index="1" name="tangent" type="Plane" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Updated docs for many VisualServer methods
2019-12-15 01:38:19 +01:00
Sets the tangent to be used with next vertex. Equivalent to [method ImmediateGeometry.set_tangent].
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
<method name="immediate_uv">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="immediate" type="RID" />
<argument index="1" name="tex_uv" type="Vector2" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Updated docs for many VisualServer methods
2019-12-15 01:38:19 +01:00
Sets the UV to be used with next vertex. Equivalent to [method ImmediateGeometry.set_uv].
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
<method name="immediate_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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="immediate" type="RID" />
<argument index="1" name="tex_uv" type="Vector2" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Updated docs for many VisualServer methods
2019-12-15 01:38:19 +01:00
Sets the UV2 to be used with next vertex. Equivalent to [method ImmediateGeometry.set_uv2].
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
<method name="immediate_vertex">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="immediate" type="RID" />
<argument index="1" name="vertex" type="Vector3" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Updated docs for many VisualServer methods
2019-12-15 01:38:19 +01:00
Adds the next vertex using the information provided in advance. Equivalent to [method ImmediateGeometry.add_vertex].
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
<method name="immediate_vertex_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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="immediate" type="RID" />
<argument index="1" name="vertex" type="Vector2" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Updated many VisualServer functions
2020-01-04 08:24:40 +01:00
Adds the next vertex using the information provided in advance. This is a helper class that calls [method immediate_vertex] under the hood. Equivalent to [method ImmediateGeometry.add_vertex].
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
<method name="init">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Updated many VisualServer functions
2020-01-04 08:24:40 +01:00
Initializes the visual server. This function is called internally by platform-dependent code during engine initialization. If called from a running game, it will not do anything.
doc: Sync classref with current source
2018-02-19 10:47:16 +01: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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="instance" type="RID" />
<argument index="1" name="id" type="int" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Updated many VisualServer functions
2020-01-04 08:24:40 +01:00
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].
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="instance" type="RID" />
<argument index="1" name="skeleton" type="RID" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Updated many VisualServer functions
2020-01-04 08:24:40 +01:00
Attaches a skeleton to an instance. Removes the previous skeleton from the instance.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="RID" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Updated many VisualServer functions
2020-01-04 08:24:40 +01:00
Creates a visual instance and adds it to the VisualServer. It can be accessed with the RID that is returned. This RID will be used in all [code]instance_*[/code] VisualServer functions.
Once finished with your RID, you will want to free the RID using the VisualServer'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].
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="RID" />
<argument index="0" name="base" type="RID" />
<argument index="1" name="scenario" type="RID" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Updated many VisualServer functions
2020-01-04 08:24:40 +01:00
Creates a visual instance, adds it to the VisualServer, and sets both base and scenario. It can be accessed with the RID that is returned. This RID will be used in all [code]instance_*[/code] VisualServer functions.
Once finished with your RID, you will want to free the RID using the VisualServer's [method free_rid] static method.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
<method name="instance_geometry_set_as_instance_lod">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="instance" type="RID" />
<argument index="1" name="as_lod_of_instance" type="RID" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Updated many VisualServer functions
2020-01-04 08:24:40 +01:00
Not implemented in Godot 3.x.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="instance" type="RID" />
<argument index="1" name="shadow_casting_setting" type="int" enum="VisualServer.ShadowCastingSetting" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Updated many VisualServer functions
2020-01-04 08:24:40 +01:00
Sets the shadow casting setting to one of [enum ShadowCastingSetting]. Equivalent to [member GeometryInstance.cast_shadow].
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
<method name="instance_geometry_set_draw_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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="instance" type="RID" />
<argument index="1" name="min" type="float" />
<argument index="2" name="max" type="float" />
<argument index="3" name="min_margin" type="float" />
<argument index="4" name="max_margin" type="float" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Updated many VisualServer functions
2020-01-04 08:24:40 +01:00
Not implemented in Godot 3.x.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="instance" type="RID" />
<argument index="1" name="flag" type="int" enum="VisualServer.InstanceFlags" />
<argument index="2" name="enabled" type="bool" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Updated many VisualServer functions
2020-01-04 08:24:40 +01:00
Sets the flag for a given [enum InstanceFlags]. See [enum InstanceFlags] for more details.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
Added material_overlay property to MeshInstance 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 GeometryInstance (and therefore MeshInstance), 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. Implemented in rasterizer of both GLES2 and GLES3.
2021-07-24 22:45:51 +02:00
<method name="instance_geometry_set_material_overlay">
<return type="void" />
<argument index="0" name="instance" type="RID" />
<argument index="1" name="material" type="RID" />
<description>
Sets a material that will be rendered for all surfaces on top of active materials for the mesh associated with this instance. Equivalent to [member GeometryInstance.material_overlay].
</description>
</method>
doc: Sync classref with current source
2018-02-19 10:47:16 +01: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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="instance" type="RID" />
<argument index="1" name="material" type="RID" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Updated many VisualServer functions
2020-01-04 08:24:40 +01:00
Sets a material that will override the material for all surfaces on the mesh associated with this instance. Equivalent to [member GeometryInstance.material_override].
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="instance" type="RID" />
<argument index="1" name="base" type="RID" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Updated many VisualServer functions
2020-01-04 08:24:40 +01:00
Sets the base of the instance. A base can be any of the 3D objects that are created in the VisualServer that can be displayed. For example, any of the light types, mesh, multimesh, immediate geometry, particle system, reflection probe, lightmap capture, and the GI probe are all types that can be set as the base of an instance in order to be displayed in the scenario.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="instance" type="RID" />
<argument index="1" name="shape" type="int" />
<argument index="2" name="weight" type="float" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Updated many VisualServer functions
2020-01-04 08:24:40 +01:00
Sets the weight for a given blend shape associated with this instance.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="instance" type="RID" />
<argument index="1" name="aabb" type="AABB" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Updated many VisualServer functions
2020-01-04 08:24:40 +01:00
Sets a custom AABB to use when culling objects from the view frustum. Equivalent to [method GeometryInstance.set_custom_aabb].
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
<method name="instance_set_exterior">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="instance" type="RID" />
<argument index="1" name="enabled" type="bool" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Updated many VisualServer functions
2020-01-04 08:24:40 +01:00
Function not implemented in Godot 3.x.
doc: Sync classref with current source
2018-02-19 10:47:16 +01: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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="instance" type="RID" />
<argument index="1" name="margin" type="float" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
class reference proofreading (cherry picked from commit 8455e901f39c90d581aeb8913640219fb8754e77)
2021-03-18 12:04:28 +01:00
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 GeometryInstance.extra_cull_margin].
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
<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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="instance" type="RID" />
<argument index="1" name="mask" type="int" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Updated many VisualServer functions
2020-01-04 08:24:40 +01:00
Sets the render layers that this instance will be drawn to. Equivalent to [member VisualInstance.layers].
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
<method name="instance_set_scenario">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="instance" type="RID" />
<argument index="1" name="scenario" type="RID" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Updated many VisualServer functions
2020-01-04 08:24:40 +01:00
Sets the scenario that the instance is in. The scenario is the 3D world that the objects will be displayed in.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
<method name="instance_set_surface_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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="instance" type="RID" />
<argument index="1" name="surface" type="int" />
<argument index="2" name="material" type="RID" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Updated many VisualServer functions
2020-01-04 08:24:40 +01:00
Sets the material of a specific surface. Equivalent to [method MeshInstance.set_surface_material].
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="instance" type="RID" />
<argument index="1" name="transform" type="Transform" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Updated many VisualServer functions
2020-01-04 08:24:40 +01:00
Sets the world space transform of the instance. Equivalent to [member Spatial.transform].
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
<method name="instance_set_use_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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="instance" type="RID" />
<argument index="1" name="lightmap_instance" type="RID" />
<argument index="2" name="lightmap" type="RID" />
<argument index="3" name="lightmap_slice" type="int" default="-1" />
<argument index="4" name="lightmap_uv_rect" type="Rect2" default="Rect2( 0, 0, 1, 1 )" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
doc: Sync classref with current source
2020-01-12 14:30:21 +01:00
Sets the lightmap to use with this instance.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="instance" type="RID" />
<argument index="1" name="visible" type="bool" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Updated many VisualServer functions
2020-01-04 08:24:40 +01:00
Sets whether an instance is drawn or not. Equivalent to [member Spatial.visible].
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
<method name="instances_cull_aabb" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="Array" />
<argument index="0" name="aabb" type="AABB" />
<argument index="1" name="scenario" type="RID" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Document most VisualServer functions
2020-01-05 09:33:16 +01:00
Returns an array of object IDs intersecting with the provided AABB. Only visual 3D nodes are considered, such as [MeshInstance] or [DirectionalLight]. Use [method @GDScript.instance_from_id] to obtain the actual nodes. A scenario RID must be provided, which is available in the [World] you want to query. This forces an update for all resources queued to update.
Updated many VisualServer functions
2020-01-04 08:24:40 +01:00
[b]Warning:[/b] This function is primarily intended for editor usage. For in-game use cases, prefer physics collision.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
<method name="instances_cull_convex" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="Array" />
<argument index="0" name="convex" type="Array" />
<argument index="1" name="scenario" type="RID" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Document most VisualServer functions
2020-01-05 09:33:16 +01:00
Returns an array of object IDs intersecting with the provided convex shape. Only visual 3D nodes are considered, such as [MeshInstance] or [DirectionalLight]. Use [method @GDScript.instance_from_id] to obtain the actual nodes. A scenario RID must be provided, which is available in the [World] you want to query. This forces an update for all resources queued to update.
Updated many VisualServer functions
2020-01-04 08:24:40 +01:00
[b]Warning:[/b] This function is primarily intended for editor usage. For in-game use cases, prefer physics collision.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
<method name="instances_cull_ray" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="Array" />
<argument index="0" name="from" type="Vector3" />
<argument index="1" name="to" type="Vector3" />
<argument index="2" name="scenario" type="RID" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Document most VisualServer functions
2020-01-05 09:33:16 +01:00
Returns an array of object IDs intersecting with the provided 3D ray. Only visual 3D nodes are considered, such as [MeshInstance] or [DirectionalLight]. Use [method @GDScript.instance_from_id] to obtain the actual nodes. A scenario RID must be provided, which is available in the [World] you want to query. This forces an update for all resources queued to update.
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-22 01:04:47 +02:00
[b]Warning:[/b] This function is primarily intended for editor usage. For in-game use cases, prefer physics collision.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="light" type="RID" />
<argument index="1" name="enable" type="bool" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Document most VisualServer functions
2020-01-05 09:33:16 +01:00
If [code]true[/code], this directional light will blend between shadow map splits resulting in a smoother transition between them. Equivalent to [member DirectionalLight.directional_shadow_blend_splits].
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
<method name="light_directional_set_shadow_depth_range_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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="light" type="RID" />
<argument index="1" name="range_mode" type="int" enum="VisualServer.LightDirectionalShadowDepthRangeMode" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Document most VisualServer functions
2020-01-05 09:33:16 +01:00
Sets the shadow depth range mode for this directional light. Equivalent to [member DirectionalLight.directional_shadow_depth_range]. See [enum LightDirectionalShadowDepthRangeMode] for options.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="light" type="RID" />
<argument index="1" name="mode" type="int" enum="VisualServer.LightDirectionalShadowMode" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Document most VisualServer functions
2020-01-05 09:33:16 +01:00
Sets the shadow mode for this directional light. Equivalent to [member DirectionalLight.directional_shadow_mode]. See [enum LightDirectionalShadowMode] for options.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
<method name="light_omni_set_shadow_detail">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="light" type="RID" />
<argument index="1" name="detail" type="int" enum="VisualServer.LightOmniShadowDetail" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Document most VisualServer functions
2020-01-05 09:33:16 +01:00
Sets whether to use vertical or horizontal detail for this omni light. This can be used to alleviate artifacts in the shadow map. Equivalent to [member OmniLight.omni_shadow_detail].
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="light" type="RID" />
<argument index="1" name="mode" type="int" enum="VisualServer.LightOmniShadowMode" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Document most VisualServer functions
2020-01-05 09:33:16 +01:00
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 OmniLight.omni_shadow_mode].
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
Disable lights for objects with baked lighting Don't apply lighting to objects when they have a lightmap texture and the light is set to BAKE_ALL. This prevents applying the same direct light twice on the same object and makes setting up scenes with mixed lighting much easier.
2020-08-30 20:16:24 +02:00
<method name="light_set_bake_mode">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="light" type="RID" />
<argument index="1" name="bake_mode" type="int" enum="VisualServer.LightBakeMode" />
Disable lights for objects with baked lighting Don't apply lighting to objects when they have a lightmap texture and the light is set to BAKE_ALL. This prevents applying the same direct light twice on the same object and makes setting up scenes with mixed lighting much easier.
2020-08-30 20:16:24 +02:00
<description>
Sets the bake mode for this light, see [enum LightBakeMode] for options. The bake mode affects how the light will be baked in [BakedLightmap]s and [GIProbe]s.
</description>
</method>
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="light" type="RID" />
<argument index="1" name="color" type="Color" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Document most VisualServer functions
2020-01-05 09:33:16 +01:00
Sets the color of the light. Equivalent to [member Light.light_color].
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="light" type="RID" />
<argument index="1" name="mask" type="int" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Document most VisualServer functions
2020-01-05 09:33:16 +01:00
Sets the cull mask for this Light. Lights only affect objects in the selected layers. Equivalent to [member Light.light_cull_mask].
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="light" type="RID" />
<argument index="1" name="enable" type="bool" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Document most VisualServer functions
2020-01-05 09:33:16 +01:00
If [code]true[/code], light will subtract light instead of adding light. Equivalent to [member Light.light_negative].
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="light" type="RID" />
<argument index="1" name="param" type="int" enum="VisualServer.LightParam" />
<argument index="2" name="value" type="float" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Document most VisualServer functions
2020-01-05 09:33:16 +01:00
Sets the specified light parameter. See [enum LightParam] for options. Equivalent to [method Light.set_param].
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="light" type="RID" />
<argument index="1" name="texture" type="RID" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Document most VisualServer functions
2020-01-05 09:33:16 +01:00
Not implemented in Godot 3.x.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="light" type="RID" />
<argument index="1" name="enabled" type="bool" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Document most VisualServer functions
2020-01-05 09:33:16 +01:00
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 Light.shadow_reverse_cull_face].
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="light" type="RID" />
<argument index="1" name="enabled" type="bool" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Document most VisualServer functions
2020-01-05 09:33:16 +01:00
If [code]true[/code], light will cast shadows. Equivalent to [member Light.shadow_enabled].
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
<method name="light_set_shadow_color">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="light" type="RID" />
<argument index="1" name="color" type="Color" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Document most VisualServer functions
2020-01-05 09:33:16 +01:00
Sets the color of the shadow cast by the light. Equivalent to [member Light.shadow_color].
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
doc: Sync classref with current source
2019-05-15 12:51:58 +02:00
<method name="light_set_use_gi">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="light" type="RID" />
<argument index="1" name="enabled" type="bool" />
doc: Sync classref with current source
2019-05-15 12:51:58 +02:00
<description>
Disable lights for objects with baked lighting Don't apply lighting to objects when they have a lightmap texture and the light is set to BAKE_ALL. This prevents applying the same direct light twice on the same object and makes setting up scenes with mixed lighting much easier.
2020-08-30 20:16:24 +02:00
Sets whether GI probes capture light information from this light. [i]Deprecated method.[/i] Use [method light_set_bake_mode] instead. This method is only kept for compatibility reasons and calls [method light_set_bake_mode] internally, setting the bake mode to [constant LIGHT_BAKE_DISABLED] or [constant LIGHT_BAKE_INDIRECT] depending on the given parameter.
doc: Sync classref with current source
2019-05-15 12:51:58 +02:00
</description>
</method>
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<method name="lightmap_capture_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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="RID" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Updated many VisualServer functions
2020-01-04 08:24:40 +01:00
Creates a lightmap capture and adds it to the VisualServer. It can be accessed with the RID that is returned. This RID will be used in all [code]lightmap_capture_*[/code] VisualServer functions.
Once finished with your RID, you will want to free the RID using the VisualServer's [method free_rid] static method.
To place in a scene, attach this lightmap capture to an instance using [method instance_set_base] using the returned RID.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
<method name="lightmap_capture_get_bounds" 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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="AABB" />
<argument index="0" name="capture" type="RID" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Finish documenting VisualServer
2020-01-06 00:36:50 +01:00
Returns the size of the lightmap capture area.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
<method name="lightmap_capture_get_energy" 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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="float" />
<argument index="0" name="capture" type="RID" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Finish documenting VisualServer
2020-01-06 00:36:50 +01:00
Returns the energy multiplier used by the lightmap capture.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
<method name="lightmap_capture_get_octree" 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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="PoolByteArray" />
<argument index="0" name="capture" type="RID" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Finish documenting VisualServer
2020-01-06 00:36:50 +01:00
Returns the octree used by the lightmap capture.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
<method name="lightmap_capture_get_octree_cell_subdiv" 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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="int" />
<argument index="0" name="capture" type="RID" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Finish documenting VisualServer
2020-01-06 00:36:50 +01:00
Returns the cell subdivision amount used by this lightmap capture's octree.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
<method name="lightmap_capture_get_octree_cell_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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="Transform" />
<argument index="0" name="capture" type="RID" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Finish documenting VisualServer
2020-01-06 00:36:50 +01:00
Returns the cell transform for this lightmap capture's octree.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
Batch of lightmapper fixes and minor improvements - Fix objects with no material being considered as fully transparent by the lightmapper. - Added "environment_min_light" property: gives artistic control over the shadow color. - Fixed "Custom Color" environment mode, it was ignored before. - Added "interior" property to BakedLightmapData: controls whether dynamic capture objects receive environment light or not. - Automatically update dynamic capture objects when the capture data changes (also works for "energy" which used to require object movement to trigger the update). - Added "use_in_baked_light" property to GridMap: controls whether the GridMap will be included in BakedLightmap bakes. - Set "flush zero" and "denormal zero" mode for SSE2 instructions in the Embree raycaster. According to Embree docs it should give a performance improvement.
2021-03-11 13:34:57 +01:00
<method name="lightmap_capture_is_interior" 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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="bool" />
<argument index="0" name="capture" type="RID" />
Batch of lightmapper fixes and minor improvements - Fix objects with no material being considered as fully transparent by the lightmapper. - Added "environment_min_light" property: gives artistic control over the shadow color. - Fixed "Custom Color" environment mode, it was ignored before. - Added "interior" property to BakedLightmapData: controls whether dynamic capture objects receive environment light or not. - Automatically update dynamic capture objects when the capture data changes (also works for "energy" which used to require object movement to trigger the update). - Added "use_in_baked_light" property to GridMap: controls whether the GridMap will be included in BakedLightmap bakes. - Set "flush zero" and "denormal zero" mode for SSE2 instructions in the Embree raycaster. According to Embree docs it should give a performance improvement.
2021-03-11 13:34:57 +01:00
<description>
Returns [code]true[/code] if capture is in "interior" mode.
</description>
</method>
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<method name="lightmap_capture_set_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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="capture" type="RID" />
<argument index="1" name="bounds" type="AABB" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Finish documenting VisualServer
2020-01-06 00:36:50 +01:00
Sets the size of the area covered by the lightmap capture. Equivalent to [member BakedLightmapData.bounds].
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
<method name="lightmap_capture_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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="capture" type="RID" />
<argument index="1" name="energy" type="float" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Finish documenting VisualServer
2020-01-06 00:36:50 +01:00
Sets the energy multiplier for this lightmap capture. Equivalent to [member BakedLightmapData.energy].
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
Batch of lightmapper fixes and minor improvements - Fix objects with no material being considered as fully transparent by the lightmapper. - Added "environment_min_light" property: gives artistic control over the shadow color. - Fixed "Custom Color" environment mode, it was ignored before. - Added "interior" property to BakedLightmapData: controls whether dynamic capture objects receive environment light or not. - Automatically update dynamic capture objects when the capture data changes (also works for "energy" which used to require object movement to trigger the update). - Added "use_in_baked_light" property to GridMap: controls whether the GridMap will be included in BakedLightmap bakes. - Set "flush zero" and "denormal zero" mode for SSE2 instructions in the Embree raycaster. According to Embree docs it should give a performance improvement.
2021-03-11 13:34:57 +01:00
<method name="lightmap_capture_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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="capture" type="RID" />
<argument index="1" name="interior" type="bool" />
Batch of lightmapper fixes and minor improvements - Fix objects with no material being considered as fully transparent by the lightmapper. - Added "environment_min_light" property: gives artistic control over the shadow color. - Fixed "Custom Color" environment mode, it was ignored before. - Added "interior" property to BakedLightmapData: controls whether dynamic capture objects receive environment light or not. - Automatically update dynamic capture objects when the capture data changes (also works for "energy" which used to require object movement to trigger the update). - Added "use_in_baked_light" property to GridMap: controls whether the GridMap will be included in BakedLightmap bakes. - Set "flush zero" and "denormal zero" mode for SSE2 instructions in the Embree raycaster. According to Embree docs it should give a performance improvement.
2021-03-11 13:34:57 +01:00
<description>
Sets the "interior" mode for this lightmap capture. Equivalent to [member BakedLightmapData.interior].
</description>
</method>
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<method name="lightmap_capture_set_octree">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="capture" type="RID" />
<argument index="1" name="octree" type="PoolByteArray" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Finish documenting VisualServer
2020-01-06 00:36:50 +01:00
Sets the octree to be used by this lightmap capture. This function is normally used by the [BakedLightmap] node. Equivalent to [member BakedLightmapData.octree].
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
<method name="lightmap_capture_set_octree_cell_subdiv">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="capture" type="RID" />
<argument index="1" name="subdiv" type="int" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Finish documenting VisualServer
2020-01-06 00:36:50 +01:00
Sets the subdivision level of this lightmap capture's octree. Equivalent to [member BakedLightmapData.cell_subdiv].
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
<method name="lightmap_capture_set_octree_cell_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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="capture" type="RID" />
<argument index="1" name="xform" type="Transform" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Finish documenting VisualServer
2020-01-06 00:36:50 +01:00
Sets the octree cell transform for this lightmap capture's octree. Equivalent to [member BakedLightmapData.cell_space_transform].
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="RID" />
<argument index="0" name="latitudes" type="int" />
<argument index="1" name="longitudes" type="int" />
<argument index="2" name="radius" type="float" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Returns a mesh of a sphere with the given amount of horizontal and vertical subdivisions.
</description>
</method>
<method name="material_create">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="RID" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Updated many VisualServer functions
2020-01-04 08:24:40 +01:00
Creates an empty material and adds it to the VisualServer. It can be accessed with the RID that is returned. This RID will be used in all [code]material_*[/code] VisualServer functions.
Once finished with your RID, you will want to free the RID using the VisualServer's [method free_rid] static method.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="Variant" />
<argument index="0" name="material" type="RID" />
<argument index="1" name="parameter" type="String" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Returns the value of a certain material's parameter.
</description>
</method>
doc: Sync classref with current source
2018-09-15 03:13:47 +02:00
<method name="material_get_param_default" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="Variant" />
<argument index="0" name="material" type="RID" />
<argument index="1" name="parameter" type="String" />
doc: Sync classref with current source
2018-09-15 03:13:47 +02:00
<description>
Change instances of "returns an empty Variant" to "returns null" in docs While "returns an empty Variant" technically valid (it's constructed as `Variant()` in C++), "returns null" is more intuitive to users.
2022-05-29 20:20:08 +02:00
Returns the default value for the param if available. Returns [code]null[/code] otherwise.
doc: Sync classref with current source
2018-09-15 03:13:47 +02:00
</description>
</method>
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<method name="material_get_shader" 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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="RID" />
<argument index="0" name="shader_material" type="RID" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Returns the shader of a certain material's shader. Returns an empty RID if the material doesn't have a shader.
</description>
</method>
<method name="material_set_line_width">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="material" type="RID" />
<argument index="1" name="width" type="float" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-22 01:04:47 +02:00
Sets a material's line width.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="material" type="RID" />
<argument index="1" name="next_material" type="RID" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-22 01:04:47 +02:00
Sets an object's next material.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="material" type="RID" />
<argument index="1" name="parameter" type="String" />
<argument index="2" name="value" type="Variant" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-22 01:04:47 +02:00
Sets a material's parameter.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="material" type="RID" />
<argument index="1" name="priority" type="int" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01: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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="shader_material" type="RID" />
<argument index="1" name="shader" type="RID" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Sets a shader material's shader.
</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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="mesh" type="RID" />
<argument index="1" name="primitive" type="int" enum="VisualServer.PrimitiveType" />
<argument index="2" name="arrays" type="Array" />
<argument index="3" name="blend_shapes" type="Array" default="[ ]" />
<argument index="4" name="compress_format" type="int" default="2194432" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
doc: Markup fixes for enums and constants
2019-12-06 23:09:20 +01:00
Adds a surface generated from the Arrays to a mesh. See [enum PrimitiveType] constants for types.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="mesh" type="RID" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01: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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="RID" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Updated many VisualServer functions
2020-01-04 08:24:40 +01:00
Creates a new mesh and adds it to the VisualServer. It can be accessed with the RID that is returned. This RID will be used in all [code]mesh_*[/code] VisualServer functions.
Once finished with your RID, you will want to free the RID using the VisualServer'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.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="int" />
<argument index="0" name="mesh" type="RID" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01: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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="int" enum="VisualServer.BlendShapeMode" />
<argument index="0" name="mesh" type="RID" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01: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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="AABB" />
<argument index="0" name="mesh" type="RID" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Returns a mesh's custom aabb.
</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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="int" />
<argument index="0" name="mesh" type="RID" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Returns a mesh's number of surfaces.
</description>
</method>
<method name="mesh_remove_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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="mesh" type="RID" />
<argument index="1" name="index" type="int" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Removes a mesh's surface.
</description>
</method>
<method name="mesh_set_blend_shape_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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="mesh" type="RID" />
<argument index="1" name="amount" type="int" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Sets a mesh's blend shape count.
</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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="mesh" type="RID" />
<argument index="1" name="mode" type="int" enum="VisualServer.BlendShapeMode" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01: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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="mesh" type="RID" />
<argument index="1" name="aabb" type="AABB" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Sets a mesh's custom aabb.
</description>
</method>
<method name="mesh_surface_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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="AABB" />
<argument index="0" name="mesh" type="RID" />
<argument index="1" name="surface" type="int" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Returns a mesh's surface's aabb.
</description>
</method>
<method name="mesh_surface_get_array" 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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="PoolByteArray" />
<argument index="0" name="mesh" type="RID" />
<argument index="1" name="surface" type="int" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Returns a mesh's surface's vertex buffer.
</description>
</method>
<method name="mesh_surface_get_array_index_len" 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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="int" />
<argument index="0" name="mesh" type="RID" />
<argument index="1" name="surface" type="int" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Returns a mesh's surface's amount of indices.
</description>
</method>
<method name="mesh_surface_get_array_len" 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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="int" />
<argument index="0" name="mesh" type="RID" />
<argument index="1" name="surface" type="int" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Returns a mesh's surface's amount of vertices.
</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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="Array" />
<argument index="0" name="mesh" type="RID" />
<argument index="1" name="surface" type="int" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Returns a mesh's surface's buffer arrays.
</description>
</method>
<method name="mesh_surface_get_blend_shape_arrays" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="Array" />
<argument index="0" name="mesh" type="RID" />
<argument index="1" name="surface" type="int" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-22 01:04:47 +02:00
Returns a mesh's surface's arrays for blend shapes.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
<method name="mesh_surface_get_format" 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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="int" />
<argument index="0" name="mesh" type="RID" />
<argument index="1" name="surface" type="int" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Returns the format of a mesh's surface.
</description>
</method>
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
<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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="int" />
<argument index="0" name="format" type="int" />
<argument index="1" name="vertex_len" type="int" />
<argument index="2" name="index_len" type="int" />
<argument index="3" name="array_index" type="int" />
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
<description>
Document most VisualServer functions
2020-01-05 09:33:16 +01:00
Function is unused in Godot 3.x.
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
</description>
</method>
<method name="mesh_surface_get_format_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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="int" />
<argument index="0" name="format" type="int" />
<argument index="1" name="vertex_len" type="int" />
<argument index="2" name="index_len" type="int" />
Fix Octahedral/Split Stream Options Update mesh_surface_get_format_stride and mesh_surface_make_offsets_from_format to return an array of offsets and an array of strides in order to support vertex stream splitting Update _get_array_from_surface to also support vertex stream splitting Add a condition on split stream usage to ensure it does not get used on dynamic meshes Handle case when Tangent is compressed but Normal is not compressed Make stream splitting option require a restart in the settings Update SoftBody and Sprite3D to support and use strides and offsets returned by updated visual_server functions Update Sprite3D to use the dynamic mesh flag
2021-08-17 02:41:43 +02:00
<argument index="3" name="array_index" type="int" />
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
<description>
</description>
</method>
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<method name="mesh_surface_get_index_array" 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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="PoolByteArray" />
<argument index="0" name="mesh" type="RID" />
<argument index="1" name="surface" type="int" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Returns a mesh's surface's index buffer.
</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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="RID" />
<argument index="0" name="mesh" type="RID" />
<argument index="1" name="surface" type="int" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Returns a mesh's surface's material.
</description>
</method>
<method name="mesh_surface_get_primitive_type" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="int" enum="VisualServer.PrimitiveType" />
<argument index="0" name="mesh" type="RID" />
<argument index="1" name="surface" type="int" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Returns the primitive type of a mesh's surface.
</description>
</method>
<method name="mesh_surface_get_skeleton_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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="Array" />
<argument index="0" name="mesh" type="RID" />
<argument index="1" name="surface" type="int" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Returns the aabb of a mesh's surface's skeleton.
</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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="mesh" type="RID" />
<argument index="1" name="surface" type="int" />
<argument index="2" name="material" type="RID" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Sets a mesh's surface's material.
</description>
</method>
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
<method name="mesh_surface_update_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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="mesh" type="RID" />
<argument index="1" name="surface" type="int" />
<argument index="2" name="offset" type="int" />
<argument index="3" name="data" type="PoolByteArray" />
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
<description>
Document most VisualServer functions
2020-01-05 09:33:16 +01:00
Updates a specific region of a vertex buffer for the specified surface. Warning: this function alters the vertex buffer directly with no safety mechanisms, you can easily corrupt your mesh.
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
</description>
</method>
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<method name="multimesh_allocate">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="multimesh" type="RID" />
<argument index="1" name="instances" type="int" />
<argument index="2" name="transform_format" type="int" enum="VisualServer.MultimeshTransformFormat" />
<argument index="3" name="color_format" type="int" enum="VisualServer.MultimeshColorFormat" />
<argument index="4" name="custom_data_format" type="int" enum="VisualServer.MultimeshCustomDataFormat" default="0" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Document most VisualServer functions
2020-01-05 09:33:16 +01:00
Allocates space for the multimesh data. Format parameters determine how the data will be stored by OpenGL. See [enum MultimeshTransformFormat], [enum MultimeshColorFormat], and [enum MultimeshCustomDataFormat] for usage. Equivalent to [member MultiMesh.instance_count].
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
Added method binding for `multimesh_create` that was missing from VisualServer class.
2019-12-01 06:47:16 +01:00
<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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="RID" />
Added method binding for `multimesh_create` that was missing from VisualServer class.
2019-12-01 06:47:16 +01:00
<description>
Updated many VisualServer functions
2020-01-04 08:24:40 +01:00
Creates a new multimesh on the VisualServer and returns an [RID] handle. This RID will be used in all [code]multimesh_*[/code] VisualServer functions.
Added method binding for `multimesh_create` that was missing from VisualServer class.
2019-12-01 06:47:16 +01:00
Once finished with your RID, you will want to free the RID using the VisualServer's [method free_rid] static method.
Updated many VisualServer functions
2020-01-04 08:24:40 +01:00
To place in a scene, attach this multimesh to an instance using [method instance_set_base] using the returned RID.
Added method binding for `multimesh_create` that was missing from VisualServer class.
2019-12-01 06:47:16 +01:00
</description>
</method>
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="AABB" />
<argument index="0" name="multimesh" type="RID" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Document most VisualServer functions
2020-01-05 09:33:16 +01:00
Calculates and returns the axis-aligned bounding box that encloses all instances within the multimesh.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="int" />
<argument index="0" name="multimesh" type="RID" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Document most VisualServer functions
2020-01-05 09:33:16 +01:00
Returns the number of instances allocated for this multimesh.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="RID" />
<argument index="0" name="multimesh" type="RID" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Document most VisualServer functions
2020-01-05 09:33:16 +01:00
Returns the RID of the mesh that will be used in drawing this multimesh.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="int" />
<argument index="0" name="multimesh" type="RID" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Document most VisualServer functions
2020-01-05 09:33:16 +01:00
Returns the number of visible instances for this multimesh.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="Color" />
<argument index="0" name="multimesh" type="RID" />
<argument index="1" name="index" type="int" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Document most VisualServer functions
2020-01-05 09:33:16 +01:00
Returns the color by which the specified instance will be modulated.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
<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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="Color" />
<argument index="0" name="multimesh" type="RID" />
<argument index="1" name="index" type="int" />
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
<description>
Document most VisualServer functions
2020-01-05 09:33:16 +01:00
Returns the custom data associated with the specified instance.
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
</description>
</method>
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="Transform" />
<argument index="0" name="multimesh" type="RID" />
<argument index="1" name="index" type="int" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Document most VisualServer functions
2020-01-05 09:33:16 +01:00
Returns the [Transform] of the specified instance.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
<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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="Transform2D" />
<argument index="0" name="multimesh" type="RID" />
<argument index="1" name="index" type="int" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Document most VisualServer functions
2020-01-05 09:33:16 +01:00
Returns the [Transform2D] of the specified instance. For use when the multimesh is set to use 2D transforms.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
<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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="multimesh" type="RID" />
<argument index="1" name="index" type="int" />
<argument index="2" name="color" type="Color" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Document most VisualServer functions
2020-01-05 09:33:16 +01:00
Sets the color by which this instance will be modulated. Equivalent to [method MultiMesh.set_instance_color].
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
<method name="multimesh_instance_set_custom_data">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="multimesh" type="RID" />
<argument index="1" name="index" type="int" />
<argument index="2" name="custom_data" type="Color" />
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
<description>
Document most VisualServer functions
2020-01-05 09:33:16 +01: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 Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
</description>
</method>
doc: Sync classref with current source
2018-02-19 10:47:16 +01: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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="multimesh" type="RID" />
<argument index="1" name="index" type="int" />
<argument index="2" name="transform" type="Transform" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Document most VisualServer functions
2020-01-05 09:33:16 +01:00
Sets the [Transform] for this instance. Equivalent to [method MultiMesh.set_instance_transform].
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
<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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="multimesh" type="RID" />
<argument index="1" name="index" type="int" />
<argument index="2" name="transform" type="Transform2D" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Document most VisualServer functions
2020-01-05 09:33:16 +01:00
Sets the [Transform2D] for this instance. For use when multimesh is used in 2D. Equivalent to [method MultiMesh.set_instance_transform_2d].
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
<method name="multimesh_set_as_bulk_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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="multimesh" type="RID" />
<argument index="1" name="array" type="PoolRealArray" />
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
<description>
Document most VisualServer functions
2020-01-05 09:33:16 +01:00
Sets all data related to the instances in one go. This is especially useful when loading the data from disk or preparing the data from GDNative.
All data is packed in one large float array. An array may look like this: Transform for instance 1, color data for instance 1, custom data for instance 1, transform for instance 2, color data for instance 2, etc.
[Transform] is stored as 12 floats, [Transform2D] is stored as 8 floats, [code]COLOR_8BIT[/code] / [code]CUSTOM_DATA_8BIT[/code] is stored as 1 float (4 bytes as is) and [code]COLOR_FLOAT[/code] / [code]CUSTOM_DATA_FLOAT[/code] is stored as 4 floats.
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
</description>
</method>
doc: Sync classref with current source
2018-02-19 10:47:16 +01: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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="multimesh" type="RID" />
<argument index="1" name="mesh" type="RID" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Document most VisualServer functions
2020-01-05 09:33:16 +01:00
Sets the mesh to be drawn by the multimesh. Equivalent to [member MultiMesh.mesh].
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
<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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="multimesh" type="RID" />
<argument index="1" name="visible" type="int" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Document most VisualServer functions
2020-01-05 09:33:16 +01:00
Sets the number of instances visible at a given time. If -1, all instances that have been allocated are drawn. Equivalent to [member MultiMesh.visible_instance_count].
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
<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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="RID" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Updated many VisualServer functions
2020-01-04 08:24:40 +01:00
Creates a new omni light and adds it to the VisualServer. It can be accessed with the RID that is returned. This RID can be used in most [code]light_*[/code] VisualServer functions.
Once finished with your RID, you will want to free the RID using the VisualServer's [method free_rid] static method.
To place in a scene, attach this omni light to an instance using [method instance_set_base] using the returned RID.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
<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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="RID" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Updated many VisualServer functions
2020-01-04 08:24:40 +01:00
Creates a particle system and adds it to the VisualServer. It can be accessed with the RID that is returned. This RID will be used in all [code]particles_*[/code] VisualServer functions.
Once finished with your RID, you will want to free the RID using the VisualServer's [method free_rid] static method.
To place in a scene, attach these particles to an instance using [method instance_set_base] using the returned RID.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
<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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="AABB" />
<argument index="0" name="particles" type="RID" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Document most VisualServer functions
2020-01-05 09:33:16 +01:00
Calculates and returns the axis-aligned bounding box that contains all the particles. Equivalent to [method Particles.capture_aabb].
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
<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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="bool" />
<argument index="0" name="particles" type="RID" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Document most VisualServer functions
2020-01-05 09:33:16 +01:00
Returns [code]true[/code] if particles are currently set to emitting.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
doc: Sync classref with current source
2019-11-11 17:25:05 +01:00
</method>
<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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="bool" />
<argument index="0" name="particles" type="RID" />
doc: Sync classref with current source
2019-11-11 17:25:05 +01:00
<description>
Document most VisualServer functions
2020-01-05 09:33:16 +01:00
Returns [code]true[/code] if particles are not emitting and particles are set to inactive.
doc: Sync classref with current source
2019-11-11 17:25:05 +01:00
</description>
</method>
<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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="particles" type="RID" />
doc: Sync classref with current source
2019-11-11 17:25:05 +01:00
<description>
Document most VisualServer functions
2020-01-05 09:33:16 +01: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
2019-11-11 17:25:05 +01:00
</description>
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</method>
<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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="particles" type="RID" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
doc: Misc updates for AnimationNode* and others - Add some missing descriptions. - Add links to tutorials for ARVR and AnimationTree. - Style fixes. - Engine changes: * Make `AnimationNodeTransition.input_<number>` properties internal so that they don't appear in the docs. They still appear in the inspector based on the actual number of inputs requested. * Drop unimplemented `CPUParticles.flatness`. It's only used for 3D particles in `ParticlesMaterial`, and thus only relevant for `CPUParticles3D`.
2020-01-23 11:14:14 +01:00
Reset the particles on the next update. Equivalent to [method Particles.restart].
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
<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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="particles" type="RID" />
<argument index="1" name="amount" type="int" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Document most VisualServer functions
2020-01-05 09:33:16 +01:00
Sets the number of particles to be drawn and allocates the memory for them. Equivalent to [member Particles.amount].
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
<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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="particles" type="RID" />
<argument index="1" name="aabb" type="AABB" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Document most VisualServer functions
2020-01-05 09:33:16 +01:00
Sets a custom axis-aligned bounding box for the particle system. Equivalent to [member Particles.visibility_aabb].
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
<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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="particles" type="RID" />
<argument index="1" name="order" type="int" enum="VisualServer.ParticlesDrawOrder" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Document most VisualServer functions
2020-01-05 09:33:16 +01: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 Particles.draw_order].
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
<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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="particles" type="RID" />
<argument index="1" name="pass" type="int" />
<argument index="2" name="mesh" type="RID" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Document most VisualServer functions
2020-01-05 09:33:16 +01:00
Sets the mesh to be used for the specified draw pass. Equivalent to [member Particles.draw_pass_1], [member Particles.draw_pass_2], [member Particles.draw_pass_3], and [member Particles.draw_pass_4].
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
<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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="particles" type="RID" />
<argument index="1" name="count" type="int" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Document most VisualServer functions
2020-01-05 09:33:16 +01:00
Sets the number of draw passes to use. Equivalent to [member Particles.draw_passes].
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
<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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="particles" type="RID" />
<argument index="1" name="transform" type="Transform" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Document most VisualServer functions
2020-01-05 09:33:16 +01:00
Sets the [Transform] that will be used by the particles when they first emit.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
<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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="particles" type="RID" />
<argument index="1" name="emitting" type="bool" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Document most VisualServer functions
2020-01-05 09:33:16 +01: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 Particles.emitting].
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
<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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="particles" type="RID" />
<argument index="1" name="ratio" type="float" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Document most VisualServer functions
2020-01-05 09:33:16 +01:00
Sets the explosiveness ratio. Equivalent to [member Particles.explosiveness].
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
<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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="particles" type="RID" />
<argument index="1" name="fps" type="int" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Document most VisualServer functions
2020-01-05 09:33:16 +01:00
Sets the frame rate that the particle system rendering will be fixed to. Equivalent to [member Particles.fixed_fps].
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
<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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="particles" type="RID" />
<argument index="1" name="enable" type="bool" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Document most VisualServer functions
2020-01-05 09:33:16 +01:00
If [code]true[/code], uses fractional delta which smooths the movement of the particles. Equivalent to [member Particles.fract_delta].
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
<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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="particles" type="RID" />
<argument index="1" name="lifetime" type="float" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Document most VisualServer functions
2020-01-05 09:33:16 +01:00
Sets the lifetime of each particle in the system. Equivalent to [member Particles.lifetime].
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
doc: Sync classref with current source
2018-02-19 10:47:16 +01: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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="particles" type="RID" />
<argument index="1" name="one_shot" type="bool" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Document most VisualServer functions
2020-01-05 09:33:16 +01:00
If [code]true[/code], particles will emit once and then stop. Equivalent to [member Particles.one_shot].
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
doc: Sync classref with current source
2018-02-19 10:47:16 +01: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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="particles" type="RID" />
<argument index="1" name="time" type="float" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
class reference proofreading (cherry picked from commit 8455e901f39c90d581aeb8913640219fb8754e77)
2021-03-18 12:04:28 +01: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 Particles.preprocess].
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
doc: Sync classref with current source
2018-02-19 10:47:16 +01: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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="particles" type="RID" />
<argument index="1" name="material" type="RID" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
doc: Fix style inconsistencies for `[b]Note:[/b]` paragraphs (cherry picked from commit 788b3aa27ac01263b2e70190ace6551504e0c81e)
2021-10-05 14:24:34 +02:00
Sets the material for processing the particles.
[b]Note:[/b] This is not the material used to draw the materials. Equivalent to [member Particles.process_material].
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
doc: Sync classref with current source
2018-02-19 10:47:16 +01: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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="particles" type="RID" />
<argument index="1" name="ratio" type="float" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Document most VisualServer functions
2020-01-05 09:33:16 +01:00
Sets the emission randomness ratio. This randomizes the emission of particles within their phase. Equivalent to [member Particles.randomness].
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
doc: Sync classref with current source
2018-02-19 10:47:16 +01: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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="particles" type="RID" />
<argument index="1" name="scale" type="float" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Document most VisualServer functions
2020-01-05 09:33:16 +01:00
Sets the speed scale of the particle system. Equivalent to [member Particles.speed_scale].
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
doc: Sync classref with current source
2018-02-19 10:47:16 +01: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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="particles" type="RID" />
<argument index="1" name="enable" type="bool" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Document most VisualServer functions
2020-01-05 09:33:16 +01:00
If [code]true[/code], particles use local coordinates. If [code]false[/code] they use global coordinates. Equivalent to [member Particles.local_coords].
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
doc: Sync classref with current source
2018-02-19 10:47:16 +01: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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="RID" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Updated many VisualServer functions
2020-01-04 08:24:40 +01:00
Creates a reflection probe and adds it to the VisualServer. It can be accessed with the RID that is returned. This RID will be used in all [code]reflection_probe_*[/code] VisualServer functions.
Once finished with your RID, you will want to free the RID using the VisualServer's [method free_rid] static method.
To place in a scene, attach this reflection probe to an instance using [method instance_set_base] using the returned RID.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
doc: Sync classref with current source
2018-02-19 10:47:16 +01: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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="probe" type="RID" />
<argument index="1" name="enable" type="bool" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Finish documenting VisualServer
2020-01-06 00:36:50 +01:00
If [code]true[/code], reflections will ignore sky contribution. Equivalent to [member ReflectionProbe.interior_enable].
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
doc: Sync classref with current source
2018-02-19 10:47:16 +01: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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="probe" type="RID" />
<argument index="1" name="layers" type="int" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Finish documenting VisualServer
2020-01-06 00:36:50 +01: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].
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
doc: Sync classref with current source
2018-02-19 10:47:16 +01: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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="probe" type="RID" />
<argument index="1" name="enable" type="bool" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Finish documenting VisualServer
2020-01-06 00:36:50 +01:00
If [code]true[/code], uses box projection. This can make reflections look more correct in certain situations. Equivalent to [member ReflectionProbe.box_projection].
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
doc: Sync classref with current source
2018-02-19 10:47:16 +01: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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="probe" type="RID" />
<argument index="1" name="enable" type="bool" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Finish documenting VisualServer
2020-01-06 00:36:50 +01: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].
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
doc: Sync classref with current source
2018-02-19 10:47:16 +01: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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="probe" type="RID" />
<argument index="1" name="extents" type="Vector3" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Finish documenting VisualServer
2020-01-06 00:36:50 +01:00
Sets the size of the area that the reflection probe will capture. Equivalent to [member ReflectionProbe.extents].
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
doc: Sync classref with current source
2018-02-19 10:47:16 +01: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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="probe" type="RID" />
<argument index="1" name="intensity" type="float" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Finish documenting VisualServer
2020-01-06 00:36:50 +01:00
Sets the intensity of the reflection probe. Intensity modulates the strength of the reflection. Equivalent to [member ReflectionProbe.intensity].
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<method name="reflection_probe_set_interior_ambient">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="probe" type="RID" />
<argument index="1" name="color" type="Color" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Finish documenting VisualServer
2020-01-06 00:36:50 +01:00
Sets the ambient light color for this reflection probe when set to interior mode. Equivalent to [member ReflectionProbe.interior_ambient_color].
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<method name="reflection_probe_set_interior_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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="probe" type="RID" />
<argument index="1" name="energy" type="float" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Finish documenting VisualServer
2020-01-06 00:36:50 +01:00
Sets the energy multiplier for this reflection probes ambient light contribution when set to interior mode. Equivalent to [member ReflectionProbe.interior_ambient_energy].
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<method name="reflection_probe_set_interior_ambient_probe_contribution">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="probe" type="RID" />
<argument index="1" name="contrib" type="float" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Finish documenting VisualServer
2020-01-06 00:36:50 +01:00
Sets the contribution value for how much the reflection affects the ambient light for this reflection probe when set to interior mode. Useful so that ambient light matches the color of the room. Equivalent to [member ReflectionProbe.interior_ambient_contrib].
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
doc: Sync classref with current source
2018-02-19 10:47:16 +01: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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="probe" type="RID" />
<argument index="1" name="distance" type="float" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Finish documenting VisualServer
2020-01-06 00:36:50 +01:00
Sets the max distance away from the probe an object can be before it is culled. Equivalent to [member ReflectionProbe.max_distance].
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
doc: Sync classref with current source
2018-02-19 10:47:16 +01: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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="probe" type="RID" />
<argument index="1" name="offset" type="Vector3" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Finish documenting VisualServer
2020-01-06 00:36:50 +01:00
Sets the origin offset to be used when this reflection probe is in box project mode. Equivalent to [member ReflectionProbe.origin_offset].
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
doc: Sync classref with current source
2018-02-19 10:47:16 +01: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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="probe" type="RID" />
<argument index="1" name="mode" type="int" enum="VisualServer.ReflectionProbeUpdateMode" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Finish documenting VisualServer
2020-01-06 00:36:50 +01:00
Sets how often the reflection probe updates. Can either be once or every frame. See [enum ReflectionProbeUpdateMode] for options.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
doc: Sync classref with current source
2018-02-19 10:47:16 +01: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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="where" type="Object" />
<argument index="1" name="method" type="String" />
<argument index="2" name="userdata" type="Variant" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-22 01:04:47 +02:00
Schedules a callback to the corresponding named [code]method[/code] on [code]where[/code] after a frame has been drawn.
The callback method must use only 1 argument which will be called with [code]userdata[/code].
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
doc: Sync classref with current source
2018-02-19 10:47:16 +01: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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="RID" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Updated many VisualServer functions
2020-01-04 08:24:40 +01:00
Creates a scenario and adds it to the VisualServer. It can be accessed with the RID that is returned. This RID will be used in all [code]scenario_*[/code] VisualServer functions.
Once finished with your RID, you will want to free the RID using the VisualServer's [method free_rid] static method.
doc: Sync classref with current source
2020-01-12 14:30:21 +01:00
The scenario is the 3D world that all the visual instances exist in.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<method name="scenario_set_debug">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="scenario" type="RID" />
<argument index="1" name="debug_mode" type="int" enum="VisualServer.ScenarioDebugMode" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Document most VisualServer functions
2020-01-05 09:33:16 +01:00
Sets the [enum ScenarioDebugMode] for this scenario. See [enum ScenarioDebugMode] for options.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
doc: Sync classref with current source
2018-02-19 10:47:16 +01: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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="scenario" type="RID" />
<argument index="1" name="environment" type="RID" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Document most VisualServer functions
2020-01-05 09:33:16 +01:00
Sets the environment that will be used with this scenario.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
doc: Sync classref with current source
2018-02-19 10:47:16 +01: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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="scenario" type="RID" />
<argument index="1" name="environment" type="RID" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Document most VisualServer functions
2020-01-05 09:33:16 +01: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.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<method name="scenario_set_reflection_atlas_size">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="scenario" type="RID" />
<argument index="1" name="size" type="int" />
<argument index="2" name="subdiv" type="int" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Document most VisualServer functions
2020-01-05 09:33:16 +01:00
Sets the size of the reflection atlas shared by all reflection probes in this scenario.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
<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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="image" type="Image" />
<argument index="1" name="color" type="Color" />
<argument index="2" name="scale" type="bool" />
<argument index="3" name="use_filter" type="bool" default="true" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Add an option to disable boot splash filtering Disabling filtering is usually desired in projects using a pixel art style. This closes #19415.
2019-06-13 22:37:19 +02:00
Sets a boot image. The color defines the background color. If [code]scale[/code] is [code]true[/code], the image will be scaled to fit the screen size. If [code]use_filter[/code] is [code]true[/code], the image will be scaled with linear interpolation. If [code]use_filter[/code] is [code]false[/code], the image will be scaled with nearest-neighbor interpolation.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
<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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="generate" type="bool" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Document most VisualServer functions
2020-01-05 09:33:16 +01:00
If [code]true[/code], the engine will generate wireframes for use with the wireframe debug mode.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
<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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="color" type="Color" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Document most VisualServer functions
2020-01-05 09:33:16 +01:00
Sets the default clear color which is used when a specific clear color has not been selected.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
Implement async shader compilation plus caching for GL ES 3 Async. compilation via ubershader is currently available in the scene and particles shaders only. Bonus: - Use `#if defined()` syntax for not true conditionals, so they don't unnecessarily take a bit in the version flagset. - Remove unused `ENABLE_CLIP_ALPHA` from scene shader. - Remove unused `PARTICLES_COPY` from the particles shader. - Remove unused uniform related code. - Shader language/compiler: use ordered hash maps for deterministic code generation (needed for caching).
2021-09-26 21:31:17 +02:00
<method name="set_shader_async_hidden_forbidden">
<return type="void" />
<argument index="0" name="forbidden" type="bool" />
<description>
If asynchronous shader compilation is enabled, this controls whether [constant SpatialMaterial.ASYNC_MODE_HIDDEN] is obeyed.
For instance, you may want to enable this temporarily before taking a screenshot. This ensures everything is visible even if shaders with async mode [i]hidden[/i] are not ready yet.
Reflection probes use this internally to ensure they capture everything regardless the shaders are ready or not.
</description>
</method>
Add shader time scaling Shaders' `TIME` will be affected by the new shader time scale, that is set via the also new `VisualServer::set_time_scale()`.
2020-06-06 18:47:03 +02:00
<method name="set_shader_time_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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="scale" type="float" />
Add shader time scaling Shaders' `TIME` will be affected by the new shader time scale, that is set via the also new `VisualServer::set_time_scale()`.
2020-06-06 18:47:03 +02:00
<description>
Sets the scale to apply to the passage of time for the shaders' [code]TIME[/code] builtin.
The default value is [code]1.0[/code], which means [code]TIME[/code] will count the real time as it goes by, without narrowing or stretching it.
</description>
</method>
Sphere occluders (portals and general use) Add framework for supporting geometrical occluders within rooms, and add support for sphere occluders. Includes gizmos for editing. They also work outside the portal system.
2021-08-05 16:44:43 +02:00
<method name="set_use_occlusion_culling">
<return type="void" />
<argument index="0" name="enable" type="bool" />
<description>
Enables or disables occlusion culling.
</description>
</method>
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<method name="shader_create">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="RID" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Updated many VisualServer functions
2020-01-04 08:24:40 +01:00
Creates an empty shader and adds it to the VisualServer. It can be accessed with the RID that is returned. This RID will be used in all [code]shader_*[/code] VisualServer functions.
Once finished with your RID, you will want to free the RID using the VisualServer's [method free_rid] static method.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="String" />
<argument index="0" name="shader" type="RID" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Returns a shader's code.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
<method name="shader_get_default_texture_param" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="RID" />
<argument index="0" name="shader" type="RID" />
<argument index="1" name="name" type="String" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Returns a default texture from a shader searched by name.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
<method name="shader_get_param_list" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="Array" />
<argument index="0" name="shader" type="RID" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Returns the parameters of a shader.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
<method name="shader_set_code">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="shader" type="RID" />
<argument index="1" name="code" type="String" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Sets a shader's code.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
<method name="shader_set_default_texture_param">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="shader" type="RID" />
<argument index="1" name="name" type="String" />
<argument index="2" name="texture" type="RID" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Sets a shader's default texture. Overwrites the texture given by name.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<method name="skeleton_allocate">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="skeleton" type="RID" />
<argument index="1" name="bones" type="int" />
<argument index="2" name="is_2d_skeleton" type="bool" default="false" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Finish documenting VisualServer
2020-01-06 00:36:50 +01:00
Allocates the GPU buffers for this skeleton.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
<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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="Transform" />
<argument index="0" name="skeleton" type="RID" />
<argument index="1" name="bone" type="int" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Finish documenting VisualServer
2020-01-06 00:36:50 +01:00
Returns the [Transform] set for a specific bone of this skeleton.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
<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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="Transform2D" />
<argument index="0" name="skeleton" type="RID" />
<argument index="1" name="bone" type="int" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Finish documenting VisualServer
2020-01-06 00:36:50 +01:00
Returns the [Transform2D] set for a specific bone of this skeleton.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="skeleton" type="RID" />
<argument index="1" name="bone" type="int" />
<argument index="2" name="transform" type="Transform" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Finish documenting VisualServer
2020-01-06 00:36:50 +01:00
Sets the [Transform] for a specific bone of this skeleton.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
<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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="skeleton" type="RID" />
<argument index="1" name="bone" type="int" />
<argument index="2" name="transform" type="Transform2D" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Finish documenting VisualServer
2020-01-06 00:36:50 +01:00
Sets the [Transform2D] for a specific bone of this skeleton.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
<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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="RID" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Updated many VisualServer functions
2020-01-04 08:24:40 +01:00
Creates a skeleton and adds it to the VisualServer. It can be accessed with the RID that is returned. This RID will be used in all [code]skeleton_*[/code] VisualServer functions.
Once finished with your RID, you will want to free the RID using the VisualServer's [method free_rid] static method.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
<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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="int" />
<argument index="0" name="skeleton" type="RID" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Finish documenting VisualServer
2020-01-06 00:36:50 +01:00
Returns the number of bones allocated for this skeleton.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<method name="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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="RID" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Updated many VisualServer functions
2020-01-04 08:24:40 +01:00
Creates an empty sky and adds it to the VisualServer. It can be accessed with the RID that is returned. This RID will be used in all [code]sky_*[/code] VisualServer functions.
Once finished with your RID, you will want to free the RID using the VisualServer's [method free_rid] static method.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
<method name="sky_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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="sky" type="RID" />
<argument index="1" name="cube_map" type="RID" />
<argument index="2" name="radiance_size" type="int" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Sets a sky's texture.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
doc: Sync classref with current source
2018-02-19 10:47:16 +01: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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="RID" />
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<description>
Updated many VisualServer functions
2020-01-04 08:24:40 +01:00
Creates a spot light and adds it to the VisualServer. It can be accessed with the RID that is returned. This RID can be used in most [code]light_*[/code] VisualServer functions.
Once finished with your RID, you will want to free the RID using the VisualServer's [method free_rid] static method.
To place in a scene, attach this spot light to an instance using [method instance_set_base] using the returned RID.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</description>
</method>
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<method name="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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Document most VisualServer functions
2020-01-05 09:33:16 +01:00
Not implemented in Godot 3.x.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
<method name="texture_allocate">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="texture" type="RID" />
<argument index="1" name="width" type="int" />
<argument index="2" name="height" type="int" />
<argument index="3" name="depth_3d" type="int" />
<argument index="4" name="format" type="int" enum="Image.Format" />
<argument index="5" name="type" type="int" enum="VisualServer.TextureType" />
<argument index="6" name="flags" type="int" default="7" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Document most VisualServer functions
2020-01-05 09:33:16 +01:00
Allocates the GPU memory for the texture.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
Adding a new Camera Server implementation to Godot. This is a new singleton where camera sources such as webcams or cameras on a mobile phone can register themselves with the Server. Other parts of Godot can interact with this to obtain images from the camera as textures. This work includes additions to the Visual Server to use this functionality to present the camera image in the background. This is specifically targetted at AR applications.
2017-08-20 16:17:24 +02:00
<method name="texture_bind">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="texture" type="RID" />
<argument index="1" name="number" type="int" />
Adding a new Camera Server implementation to Godot. This is a new singleton where camera sources such as webcams or cameras on a mobile phone can register themselves with the Server. Other parts of Godot can interact with this to obtain images from the camera as textures. This work includes additions to the Visual Server to use this functionality to present the camera image in the background. This is specifically targetted at AR applications.
2017-08-20 16:17:24 +02:00
<description>
Binds the texture to a texture slot.
</description>
</method>
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<method name="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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="RID" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Updated many VisualServer functions
2020-01-04 08:24:40 +01:00
Creates an empty texture and adds it to the VisualServer. It can be accessed with the RID that is returned. This RID will be used in all [code]texture_*[/code] VisualServer functions.
Once finished with your RID, you will want to free the RID using the VisualServer's [method free_rid] static method.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
<method name="texture_create_from_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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="RID" />
<argument index="0" name="image" type="Image" />
<argument index="1" name="flags" type="int" default="7" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Creates a texture, allocates the space for an image, and fills in the image.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
<method name="texture_debug_usage">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="Array" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
doc: Sync classref with current source
2017-12-10 00:43:30 +01:00
Returns a list of all the textures and their information.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
<method name="texture_get_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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="Image" />
<argument index="0" name="texture" type="RID" />
<argument index="1" name="cube_side" type="int" default="0" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Fix typos in code and docs with codespell Using v1.11.0 from https://github.com/lucasdemarchi/codespell
2018-01-18 21:37:17 +01:00
Returns a copy of a texture's image unless it's a CubeMap, in which case it returns the [RID] of the image at one of the cubes sides.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
doc: Sync classref with current source
2018-08-21 00:35:30 +02:00
<method name="texture_get_depth" 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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="int" />
<argument index="0" name="texture" type="RID" />
doc: Sync classref with current source
2018-08-21 00:35:30 +02:00
<description>
Document most VisualServer functions
2020-01-05 09:33:16 +01:00
Returns the depth of the texture.
doc: Sync classref with current source
2018-08-21 00:35:30 +02:00
</description>
</method>
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<method name="texture_get_flags" 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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="int" />
<argument index="0" name="texture" type="RID" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Returns the flags of a texture.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
<method name="texture_get_format" 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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="int" enum="Image.Format" />
<argument index="0" name="texture" type="RID" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Returns the format of the texture's image.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
<method name="texture_get_height" 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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="int" />
<argument index="0" name="texture" type="RID" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Returns the texture's height.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="String" />
<argument index="0" name="texture" type="RID" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Returns the texture's path.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
<method name="texture_get_texid" 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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="int" />
<argument index="0" name="texture" type="RID" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Returns the opengl id of the texture's image.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
doc: Sync classref with current source
2018-08-21 00:35:30 +02:00
<method name="texture_get_type" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="int" enum="VisualServer.TextureType" />
<argument index="0" name="texture" type="RID" />
doc: Sync classref with current source
2018-08-21 00:35:30 +02:00
<description>
Document most VisualServer functions
2020-01-05 09:33:16 +01:00
Returns the type of the texture, can be any of the [enum TextureType].
doc: Sync classref with current source
2018-08-21 00:35:30 +02:00
</description>
</method>
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<method name="texture_get_width" 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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="int" />
<argument index="0" name="texture" type="RID" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Returns the texture's width.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
<method name="texture_set_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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="texture" type="RID" />
<argument index="1" name="image" type="Image" />
<argument index="2" name="layer" type="int" default="0" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Sets the texture's image data. If it's a CubeMap, it sets the image data at a cube side.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
Sync classref with current source
2018-05-12 09:38:00 +02:00
<method name="texture_set_data_partial">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="texture" type="RID" />
<argument index="1" name="image" type="Image" />
<argument index="2" name="src_x" type="int" />
<argument index="3" name="src_y" type="int" />
<argument index="4" name="src_w" type="int" />
<argument index="5" name="src_h" type="int" />
<argument index="6" name="dst_x" type="int" />
<argument index="7" name="dst_y" type="int" />
<argument index="8" name="dst_mip" type="int" />
<argument index="9" name="layer" type="int" default="0" />
Sync classref with current source
2018-05-12 09:38:00 +02:00
<description>
Document most VisualServer functions
2020-01-05 09:33:16 +01:00
Sets a part of the data for a texture. Warning: this function calls the underlying graphics API directly and may corrupt your texture if used improperly.
Sync classref with current source
2018-05-12 09:38:00 +02:00
</description>
</method>
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<method name="texture_set_flags">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="texture" type="RID" />
<argument index="1" name="flags" type="int" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-22 01:04:47 +02:00
Sets the texture's flags. See [enum TextureFlags] for options.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
<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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="texture" type="RID" />
<argument index="1" name="path" type="String" />
doc: Sync classref with current source Ensure that s/fixed_process/physics_process/ is handled properly. [ci skip]
2017-10-11 23:54:43 +02:00
<description>
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Sets the texture's path.
doc: Sync classref with current source Ensure that s/fixed_process/physics_process/ is handled properly. [ci skip]
2017-10-11 23:54:43 +02:00
</description>
</method>
Expose VisualServer.texture_set_proxy() to GDScript Expose VisualServer.texture_set_proxy() to GDScript
2021-11-06 20:45:26 +01:00
<method name="texture_set_proxy">
<return type="void" />
<argument index="0" name="proxy" type="RID" />
<argument index="1" name="base" type="RID" />
<description>
Creates an update link between two textures, similar to how [ViewportTexture]s operate. When the base texture is the texture of a [Viewport], every time the viewport renders a new frame, the proxy texture automatically receives an update.
For example, this code links a generic [ImageTexture] to the texture output of the [Viewport] using the VisualServer API:
[codeblock]
func _ready():
var viewport_rid = get_viewport().get_viewport_rid()
var viewport_texture_rid = VisualServer.viewport_get_texture(viewport_rid)
var proxy_texture = ImageTexture.new()
var viewport_texture_image_data = VisualServer.texture_get_data(viewport_texture_rid)
proxy_texture.create_from_image(viewport_texture_image_data)
var proxy_texture_rid = proxy_texture.get_rid()
VisualServer.texture_set_proxy(proxy_texture_rid, viewport_texture_rid)
$TextureRect.texture = proxy_texture
[/codeblock]
</description>
</method>
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<method name="texture_set_shrink_all_x2_on_set_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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="shrink" type="bool" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
doc: Add missing commas after "If true/false"
2018-12-20 13:46:54 +01:00
If [code]true[/code], sets internal processes to shrink all image data to half the size.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
<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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="texture" type="RID" />
<argument index="1" name="width" type="int" />
<argument index="2" name="height" type="int" />
<argument index="3" name="depth" type="int" />
Expose 'request_frame_drawn_callback' to script.
2017-10-14 17:32:27 +02:00
<description>
Document most VisualServer functions
2020-01-05 09:33:16 +01:00
Resizes the texture to the specified dimensions.
Expose 'request_frame_drawn_callback' to script.
2017-10-14 17:32:27 +02:00
</description>
</method>
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<method name="textures_keep_original">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="enable" type="bool" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
doc: Add missing commas after "If true/false"
2018-12-20 13:46:54 +01:00
If [code]true[/code], the image will be stored in the texture's images array if overwritten.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="viewport" type="RID" />
<argument index="1" name="camera" type="RID" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Sets a viewport's camera.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
<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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="viewport" type="RID" />
<argument index="1" name="canvas" type="RID" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Sets a viewport's canvas.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
<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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="viewport" type="RID" />
<argument index="1" name="rect" type="Rect2" default="Rect2( 0, 0, 0, 0 )" />
<argument index="2" name="screen" type="int" default="0" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Complete various class references
2020-01-26 06:59:51 +01:00
Copies viewport to a region of the screen specified by [code]rect[/code]. If [member Viewport.render_direct_to_screen] is [code]true[/code], then viewport does not use a framebuffer and the contents of the viewport are rendered directly to screen. However, note that the root viewport is drawn last, therefore it will draw over the screen. Accordingly, you must set the root viewport to an area that does not cover the area that you have attached this viewport to.
Implement ability to render viewports directly to screen
2019-05-08 20:25:34 +02:00
For example, you can set the root viewport to not render at all with the following code:
[codeblock]
func _ready():
get_viewport().set_attach_to_screen_rect(Rect2())
$Viewport.set_attach_to_screen_rect(Rect2(0, 0, 600, 600))
[/codeblock]
i18n: Misc fixes translation strings Adds some translator comments to solve some questions raised on Weblate.
2022-06-08 11:42:51 +02: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 12:02:08 +02:00
</description>
</method>
<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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="RID" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<description>
Updated many VisualServer functions
2020-01-04 08:24:40 +01:00
Creates an empty viewport and adds it to the VisualServer. It can be accessed with the RID that is returned. This RID will be used in all [code]viewport_*[/code] VisualServer functions.
Once finished with your RID, you will want to free the RID using the VisualServer's [method free_rid] static method.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</description>
</method>
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<method name="viewport_detach">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="viewport" type="RID" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Detaches the viewport from the screen.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
<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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="int" />
<argument index="0" name="viewport" type="RID" />
<argument index="1" name="info" type="int" enum="VisualServer.ViewportRenderInfo" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
doc: Markup fixes for enums and constants
2019-12-06 23:09:20 +01:00
Returns a viewport's render information. For options, see the [enum ViewportRenderInfo] constants.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
<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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="RID" />
<argument index="0" name="viewport" type="RID" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Returns the viewport's last rendered frame.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
<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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="viewport" type="RID" />
<argument index="1" name="canvas" type="RID" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<description>
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Detaches a viewport from a canvas and vice versa.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</description>
</method>
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<method name="viewport_set_active">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="viewport" type="RID" />
<argument index="1" name="active" type="bool" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<description>
doc: Add missing commas after "If true/false"
2018-12-20 13:46:54 +01:00
If [code]true[/code], sets the viewport active, else sets it inactive.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</description>
</method>
Fix canvas stacking not deterministic on same layer Fixes #22687.
2018-10-30 21:53:00 +01: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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="viewport" type="RID" />
<argument index="1" name="canvas" type="RID" />
<argument index="2" name="layer" type="int" />
<argument index="3" name="sublayer" type="int" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<description>
Fix canvas stacking not deterministic on same layer Fixes #22687.
2018-10-30 21:53:00 +01:00
Sets the stacking order for a viewport's canvas.
[code]layer[/code] is the actual canvas layer, while [code]sublayer[/code] specifies the stacking order of the canvas among those in the same layer.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</description>
</method>
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<method name="viewport_set_canvas_transform">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="viewport" type="RID" />
<argument index="1" name="canvas" type="RID" />
<argument index="2" name="offset" type="Transform2D" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<description>
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Sets the transformation of a viewport's canvas.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</description>
</method>
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<method name="viewport_set_clear_mode">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="viewport" type="RID" />
<argument index="1" name="clear_mode" type="int" enum="VisualServer.ViewportClearMode" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<description>
doc: Fix scoped hyperlinks to same-class enums/methods The class name does not need to be specified when it is the current class.
2019-06-27 11:44:37 +02:00
Sets the clear mode of a viewport. See [enum ViewportClearMode] for options.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</description>
</method>
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<method name="viewport_set_debug_draw">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="viewport" type="RID" />
<argument index="1" name="draw" type="int" enum="VisualServer.ViewportDebugDraw" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
doc: Fix scoped hyperlinks to same-class enums/methods The class name does not need to be specified when it is the current class.
2019-06-27 11:44:37 +02:00
Sets the debug draw mode of a viewport. See [enum ViewportDebugDraw] for options.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
<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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="viewport" type="RID" />
<argument index="1" name="disabled" type="bool" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
doc: Add missing commas after "If true/false"
2018-12-20 13:46:54 +01:00
If [code]true[/code], a viewport's 3D rendering is disabled.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
<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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="viewport" type="RID" />
<argument index="1" name="disabled" type="bool" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
doc: Add missing commas after "If true/false"
2018-12-20 13:46:54 +01:00
If [code]true[/code], rendering of a viewport's environment is disabled.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
<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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="viewport" type="RID" />
<argument index="1" name="transform" type="Transform2D" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Sets the viewport's global transformation matrix.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
<method name="viewport_set_hdr">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="viewport" type="RID" />
<argument index="1" name="enabled" type="bool" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
doc: Add missing commas after "If true/false"
2018-12-20 13:46:54 +01:00
If [code]true[/code], the viewport renders to hdr.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
<method name="viewport_set_hide_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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="viewport" type="RID" />
<argument index="1" name="hidden" type="bool" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
doc: Add missing commas after "If true/false"
2018-12-20 13:46:54 +01:00
If [code]true[/code], the viewport's canvas is not rendered.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
<method name="viewport_set_hide_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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="viewport" type="RID" />
<argument index="1" name="hidden" type="bool" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Updated many VisualServer functions
2020-01-04 08:24:40 +01:00
Currently unimplemented in Godot 3.x.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
<method name="viewport_set_msaa">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="viewport" type="RID" />
<argument index="1" name="msaa" type="int" enum="VisualServer.ViewportMSAA" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-22 01:04:47 +02:00
Sets the anti-aliasing mode. See [enum ViewportMSAA] for options.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
<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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="viewport" type="RID" />
<argument index="1" name="parent_viewport" type="RID" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Sets the viewport's parent to another viewport.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
Implement ability to render viewports directly to screen
2019-05-08 20:25:34 +02:00
<method name="viewport_set_render_direct_to_screen">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="viewport" type="RID" />
<argument index="1" name="enabled" type="bool" />
Implement ability to render viewports directly to screen
2019-05-08 20:25:34 +02:00
<description>
If [code]true[/code], render the contents of the viewport directly to screen. This allows a low-level optimization where you can skip drawing a viewport to the root viewport. While this optimization can result in a significant increase in speed (especially on older devices), it comes at a cost of usability. When this is enabled, you cannot read from the viewport or from the [code]SCREEN_TEXTURE[/code]. You also lose the benefit of certain window settings, such as the various stretch modes. Another consequence to be aware of is that in 2D the rendering happens in window coordinates, so if you have a viewport that is double the size of the window, and you set this, then only the portion that fits within the window will be drawn, no automatic scaling is possible, even if your game scene is significantly larger than the window size.
</description>
</method>
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<method name="viewport_set_scenario">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="viewport" type="RID" />
<argument index="1" name="scenario" type="RID" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Sets a viewport's scenario.
The scenario contains information about the [enum ScenarioDebugMode], environment information, reflection atlas etc.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
<method name="viewport_set_shadow_atlas_quadrant_subdivision">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="viewport" type="RID" />
<argument index="1" name="quadrant" type="int" />
<argument index="2" name="subdivision" type="int" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Sets the shadow atlas quadrant's subdivision.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
<method name="viewport_set_shadow_atlas_size">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="viewport" type="RID" />
<argument index="1" name="size" type="int" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Improve documentation pertaining to shadow atlas sizes This partially addresses #27650.
2019-09-04 23:32:46 +02:00
Sets the size of the shadow atlas's images (used for omni and spot lights). The value will be rounded up to the nearest power of 2.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
Add support for contrast-adaptive sharpening in 3D (GLES3 only) This is an older, easier to implement variant of CAS as a pure fragment shader. It doesn't support upscaling, but we won't make use of it (at least for now). The sharpening intensity can be adjusted on a per-Viewport basis. For the root viewport, it can be adjusted in the Project Settings. Since `textureLodOffset()` isn't available in GLES2, there is no way to support contrast-adaptive sharpening in GLES2.
2021-03-27 18:58:12 +01:00
<method name="viewport_set_sharpen_intensity">
Fixup doc formatting after #47416
2021-08-10 12:11:30 +02:00
<return type="void" />
<argument index="0" name="viewport" type="RID" />
<argument index="1" name="intensity" type="float" />
Add support for contrast-adaptive sharpening in 3D (GLES3 only) This is an older, easier to implement variant of CAS as a pure fragment shader. It doesn't support upscaling, but we won't make use of it (at least for now). The sharpening intensity can be adjusted on a per-Viewport basis. For the root viewport, it can be adjusted in the Project Settings. Since `textureLodOffset()` isn't available in GLES2, there is no way to support contrast-adaptive sharpening in GLES2.
2021-03-27 18:58:12 +01:00
<description>
Sets the sharpening [code]intensity[/code] for the [code]viewport[/code]. If set to a value greater than [code]0.0[/code], contrast-adaptive sharpening will be applied to the 3D viewport. This has a low performance cost and can be used to recover some of the sharpness lost from using FXAA. Values around [code]0.5[/code] generally give the best results. See also [method viewport_set_use_fxaa].
</description>
</method>
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<method name="viewport_set_size">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="viewport" type="RID" />
<argument index="1" name="width" type="int" />
<argument index="2" name="height" type="int" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Sets the viewport's width and height.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
<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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="viewport" type="RID" />
<argument index="1" name="enabled" type="bool" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
doc: Add missing commas after "If true/false"
2018-12-20 13:46:54 +01:00
If [code]true[/code], the viewport renders its background as transparent.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
<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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="viewport" type="RID" />
<argument index="1" name="update_mode" type="int" enum="VisualServer.ViewportUpdateMode" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
[DOCS] Classref additions and corrections
2018-09-01 20:07:51 +02:00
Sets when the viewport should be updated. See [enum ViewportUpdateMode] constants for options.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
<method name="viewport_set_usage">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="viewport" type="RID" />
<argument index="1" name="usage" type="int" enum="VisualServer.ViewportUsage" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
[DOCS] Classref additions and corrections
2018-09-01 20:07:51 +02:00
Sets the viewport's 2D/3D mode. See [enum ViewportUsage] constants for options.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
<method name="viewport_set_use_arvr">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="viewport" type="RID" />
<argument index="1" name="use_arvr" type="bool" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
doc: Add missing commas after "If true/false"
2018-12-20 13:46:54 +01:00
If [code]true[/code], the viewport uses augmented or virtual reality technologies. See [ARVRInterface].
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
Add a debanding property to Viewport for GLES3 It can be enabled in the Project Settings (`rendering/quality/filters/use_debanding`). It's disabled by default as it has a small performance impact and can make PNG screenshots much larger (due to how dithering works). As a result, it should be enabled only when banding is noticeable enough. Since debanding requires a HDR viewport to work, it's only supported in the GLES3 backend.
2020-10-20 18:58:07 +02:00
<method name="viewport_set_use_debanding">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="viewport" type="RID" />
<argument index="1" name="debanding" type="bool" />
Add a debanding property to Viewport for GLES3 It can be enabled in the Project Settings (`rendering/quality/filters/use_debanding`). It's disabled by default as it has a small performance impact and can make PNG screenshots much larger (due to how dithering works). As a result, it should be enabled only when banding is noticeable enough. Since debanding requires a HDR viewport to work, it's only supported in the GLES3 backend.
2020-10-20 18:58:07 +02:00
<description>
If [code]true[/code], uses a fast post-processing filter to make banding significantly less visible. In some cases, debanding may introduce a slightly noticeable dithering pattern. It's recommended to enable debanding only when actually needed since the dithering pattern will make lossless-compressed screenshots larger.
[b]Note:[/b] Only available on the GLES3 backend. [member Viewport.hdr] must also be [code]true[/code] for debanding to be effective.
</description>
</method>
Add fast approximate antialiasing (FXAA) to Viewport This backports FXAA from the `master` branch. Co-authored-by: Clay John <claynjohn@gmail.com>
2020-08-22 00:15:50 +02:00
<method name="viewport_set_use_fxaa">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="viewport" type="RID" />
<argument index="1" name="fxaa" type="bool" />
Add fast approximate antialiasing (FXAA) to Viewport This backports FXAA from the `master` branch. Co-authored-by: Clay John <claynjohn@gmail.com>
2020-08-22 00:15:50 +02:00
<description>
Add support for contrast-adaptive sharpening in 3D (GLES3 only) This is an older, easier to implement variant of CAS as a pure fragment shader. It doesn't support upscaling, but we won't make use of it (at least for now). The sharpening intensity can be adjusted on a per-Viewport basis. For the root viewport, it can be adjusted in the Project Settings. Since `textureLodOffset()` isn't available in GLES2, there is no way to support contrast-adaptive sharpening in GLES2.
2021-03-27 18:58:12 +01:00
Enables fast approximate antialiasing for this viewport. FXAA is a popular screen-space antialiasing method, which is fast but will make the image look blurry, especially at lower resolutions. It can still work relatively well at large resolutions such as 1440p and 4K. Some of the lost sharpness can be recovered by enabling contrast-adaptive sharpening (see [method viewport_set_sharpen_intensity]).
Add fast approximate antialiasing (FXAA) to Viewport This backports FXAA from the `master` branch. Co-authored-by: Clay John <claynjohn@gmail.com>
2020-08-22 00:15:50 +02:00
</description>
</method>
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<method name="viewport_set_vflip">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="viewport" type="RID" />
<argument index="1" name="enabled" type="bool" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<description>
doc: Add missing commas after "If true/false"
2018-12-20 13:46:54 +01:00
If [code]true[/code], the viewport's rendering is flipped vertically.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</description>
</method>
</methods>
Expose disable_render_loop property to GDScript
2020-06-18 12:49:24 +02:00
<members>
<member name="render_loop_enabled" type="bool" setter="set_render_loop_enabled" getter="is_render_loop_enabled">
If [code]false[/code], disables rendering completely, but the engine logic is still being processed. You can call [method force_draw] to draw a frame even with rendering disabled.
</member>
</members>
doc: Sync classref with current source
2017-11-15 20:35:18 +01:00
<signals>
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
<signal name="frame_post_draw">
<description>
Updated docs for many VisualServer methods
2019-12-15 01:38:19 +01:00
Emitted at the end of the frame, after the VisualServer has finished updating all the Viewports.
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
</description>
</signal>
<signal name="frame_pre_draw">
doc: Sync classref with current source
2017-11-15 20:35:18 +01:00
<description>
Updated docs for many VisualServer methods
2019-12-15 01:38:19 +01:00
Emitted at the beginning of the frame, before the VisualServer updates all the Viewports.
doc: Sync classref with current source
2017-11-15 20:35:18 +01:00
</description>
</signal>
</signals>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<constants>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="NO_INDEX_ARRAY" value="-1">
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Marks an error that shows that the index array is empty.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="ARRAY_WEIGHTS_SIZE" value="4">
Finish documenting VisualServer
2020-01-06 00:36:50 +01:00
Number of weights/bones per vertex.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="CANVAS_ITEM_Z_MIN" value="-4096">
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
The minimum Z-layer for canvas items.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="CANVAS_ITEM_Z_MAX" value="4096">
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
The maximum Z-layer for canvas items.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="MAX_GLOW_LEVELS" value="7">
Finish documenting VisualServer
2020-01-06 00:36:50 +01:00
Max number of glow levels that can be used with glow post-process effect.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="MAX_CURSORS" value="8">
Finish documenting VisualServer
2020-01-06 00:36:50 +01:00
Unused enum in Godot 3.x.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="MATERIAL_RENDER_PRIORITY_MIN" value="-128">
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
The minimum renderpriority of all materials.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="MATERIAL_RENDER_PRIORITY_MAX" value="127">
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
The maximum renderpriority of all materials.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="CUBEMAP_LEFT" value="0" enum="CubeMapSide">
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Marks the left side of a cubemap.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="CUBEMAP_RIGHT" value="1" enum="CubeMapSide">
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Marks the right side of a cubemap.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="CUBEMAP_BOTTOM" value="2" enum="CubeMapSide">
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Marks the bottom side of a cubemap.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="CUBEMAP_TOP" value="3" enum="CubeMapSide">
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Marks the top side of a cubemap.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="CUBEMAP_FRONT" value="4" enum="CubeMapSide">
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Marks the front side of a cubemap.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="CUBEMAP_BACK" value="5" enum="CubeMapSide">
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Marks the back side of a cubemap.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Sync classref with current source
2018-08-21 00:35:30 +02:00
<constant name="TEXTURE_TYPE_2D" value="0" enum="TextureType">
Finish documenting VisualServer
2020-01-06 00:36:50 +01:00
Normal texture with 2 dimensions, width and height.
doc: Sync classref with current source
2018-08-21 00:35:30 +02:00
</constant>
Sync classref with current source
2020-03-25 11:42:15 +01:00
<constant name="TEXTURE_TYPE_CUBEMAP" value="2" enum="TextureType">
Finish documenting VisualServer
2020-01-06 00:36:50 +01:00
Texture made up of six faces, can be looked up with a [code]vec3[/code] in shader.
doc: Sync classref with current source
2018-08-21 00:35:30 +02:00
</constant>
Sync classref with current source
2020-03-25 11:42:15 +01:00
<constant name="TEXTURE_TYPE_2D_ARRAY" value="3" enum="TextureType">
Finish documenting VisualServer
2020-01-06 00:36:50 +01:00
An array of 2-dimensional textures.
doc: Sync classref with current source
2018-08-21 00:35:30 +02:00
</constant>
Sync classref with current source
2020-03-25 11:42:15 +01:00
<constant name="TEXTURE_TYPE_3D" value="4" enum="TextureType">
Finish documenting VisualServer
2020-01-06 00:36:50 +01:00
A 3-dimensional texture with width, height, and depth.
doc: Sync classref with current source
2018-08-21 00:35:30 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="TEXTURE_FLAG_MIPMAPS" value="1" enum="TextureFlags">
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-22 01:04:47 +02:00
Generates mipmaps, which are smaller versions of the same texture to use when zoomed out, keeping the aspect ratio.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="TEXTURE_FLAG_REPEAT" value="2" enum="TextureFlags">
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-22 01:04:47 +02:00
Repeats the texture (instead of clamp to edge).
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="TEXTURE_FLAG_FILTER" value="4" enum="TextureFlags">
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-22 01:04:47 +02:00
Uses a magnifying filter, to enable smooth zooming in of the texture.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="TEXTURE_FLAG_ANISOTROPIC_FILTER" value="8" enum="TextureFlags">
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-22 01:04:47 +02:00
Uses anisotropic mipmap filtering. Generates smaller versions of the same texture with different aspect ratios.
This results in better-looking textures when viewed from oblique angles.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="TEXTURE_FLAG_CONVERT_TO_LINEAR" value="16" enum="TextureFlags">
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-22 01:04:47 +02:00
Converts the texture to the sRGB color space.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="TEXTURE_FLAG_MIRRORED_REPEAT" value="32" enum="TextureFlags">
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-22 01:04:47 +02:00
Repeats the texture with alternate sections mirrored.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Sync classref with current source
2018-08-21 00:35:30 +02:00
<constant name="TEXTURE_FLAG_USED_FOR_STREAMING" value="2048" enum="TextureFlags">
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Texture is a video surface.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="TEXTURE_FLAGS_DEFAULT" value="7" enum="TextureFlags">
doc: Remove hardcoded default values from descriptions They are now generated automatically by doctool.
2019-06-29 15:24:23 +02:00
Default flags. [constant TEXTURE_FLAG_MIPMAPS], [constant TEXTURE_FLAG_REPEAT] and [constant TEXTURE_FLAG_FILTER] are enabled.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="SHADER_SPATIAL" value="0" enum="ShaderMode">
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Shader is a 3D shader.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="SHADER_CANVAS_ITEM" value="1" enum="ShaderMode">
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Shader is a 2D shader.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="SHADER_PARTICLES" value="2" enum="ShaderMode">
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Shader is a particle shader.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="SHADER_MAX" value="3" enum="ShaderMode">
doc: Complete and harmonize all _MAX constant descriptions
2019-06-27 11:10:53 +02:00
Represents the size of the [enum ShaderMode] enum.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="ARRAY_VERTEX" value="0" enum="ArrayType">
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Array is a vertex array.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="ARRAY_NORMAL" value="1" enum="ArrayType">
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Array is a normal array.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="ARRAY_TANGENT" value="2" enum="ArrayType">
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Array is a tangent array.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="ARRAY_COLOR" value="3" enum="ArrayType">
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Array is a color array.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="ARRAY_TEX_UV" value="4" enum="ArrayType">
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-22 01:04:47 +02:00
Array is an UV coordinates array.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="ARRAY_TEX_UV2" value="5" enum="ArrayType">
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-22 01:04:47 +02:00
Array is an UV coordinates array for the second UV coordinates.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="ARRAY_BONES" value="6" enum="ArrayType">
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Array contains bone information.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="ARRAY_WEIGHTS" value="7" enum="ArrayType">
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Array is weight information.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="ARRAY_INDEX" value="8" enum="ArrayType">
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Array is index array.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="ARRAY_MAX" value="9" enum="ArrayType">
doc: Complete and harmonize all _MAX constant descriptions
2019-06-27 11:10:53 +02:00
Represents the size of the [enum ArrayType] enum.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="ARRAY_FORMAT_VERTEX" value="1" enum="ArrayFormat">
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Flag used to mark a vertex array.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="ARRAY_FORMAT_NORMAL" value="2" enum="ArrayFormat">
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Flag used to mark a normal array.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="ARRAY_FORMAT_TANGENT" value="4" enum="ArrayFormat">
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Flag used to mark a tangent array.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="ARRAY_FORMAT_COLOR" value="8" enum="ArrayFormat">
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Flag used to mark a color array.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="ARRAY_FORMAT_TEX_UV" value="16" enum="ArrayFormat">
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-22 01:04:47 +02:00
Flag used to mark an UV coordinates array.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="ARRAY_FORMAT_TEX_UV2" value="32" enum="ArrayFormat">
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-22 01:04:47 +02:00
Flag used to mark an UV coordinates array for the second UV coordinates.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="ARRAY_FORMAT_BONES" value="64" enum="ArrayFormat">
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Flag used to mark a bone information array.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="ARRAY_FORMAT_WEIGHTS" value="128" enum="ArrayFormat">
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Flag used to mark a weights array.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="ARRAY_FORMAT_INDEX" value="256" enum="ArrayFormat">
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-22 01:04:47 +02:00
Flag used to mark an index array.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="ARRAY_COMPRESS_VERTEX" value="512" enum="ArrayFormat">
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Flag used to mark a compressed (half float) vertex array.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="ARRAY_COMPRESS_NORMAL" value="1024" enum="ArrayFormat">
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Flag used to mark a compressed (half float) normal array.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="ARRAY_COMPRESS_TANGENT" value="2048" enum="ArrayFormat">
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Flag used to mark a compressed (half float) tangent array.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="ARRAY_COMPRESS_COLOR" value="4096" enum="ArrayFormat">
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Flag used to mark a compressed (half float) color array.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="ARRAY_COMPRESS_TEX_UV" value="8192" enum="ArrayFormat">
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-22 01:04:47 +02:00
Flag used to mark a compressed (half float) UV coordinates array.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="ARRAY_COMPRESS_TEX_UV2" value="16384" enum="ArrayFormat">
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-22 01:04:47 +02:00
Flag used to mark a compressed (half float) UV coordinates array for the second UV coordinates.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="ARRAY_COMPRESS_BONES" value="32768" enum="ArrayFormat">
Finish documenting VisualServer
2020-01-06 00:36:50 +01:00
Flag used to mark a compressed bone array.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="ARRAY_COMPRESS_WEIGHTS" value="65536" enum="ArrayFormat">
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Flag used to mark a compressed (half float) weight array.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="ARRAY_COMPRESS_INDEX" value="131072" enum="ArrayFormat">
Finish documenting VisualServer
2020-01-06 00:36:50 +01:00
Flag used to mark a compressed index array.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="ARRAY_FLAG_USE_2D_VERTICES" value="262144" enum="ArrayFormat">
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Flag used to mark that the array contains 2D vertices.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="ARRAY_FLAG_USE_16_BIT_BONES" value="524288" enum="ArrayFormat">
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-22 01:04:47 +02:00
Flag used to mark that the array uses 16-bit bones instead of 8-bit.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
Octahedral Normal/Tangent Compression Implement Octahedral Compression for normal/tangent vectors *Oct32 for uncompressed vectors *Oct16 for compressed vectors Reduces vertex size for each attribute by *Uncompressed: 12 bytes, vec4<float32> -> vec2<unorm16> *Compressed: 2 bytes, vec4<unorm8> -> vec2<unorm8> Binormal sign is encoded in the y coordinate of the encoded tangent Added conversion functions to go from octahedral mapping to cartesian for normal and tangent vectors sprite_3d and soft_body meshes write to their vertex buffer memory directly and need to convert their normals and tangents to the new oct format before writing Created a new mesh flag to specify whether a mesh is using octahedral compression or not Updated documentation to discuss new flag/defaults Created shader flags to specify whether octahedral or cartesian vectors are being used Updated importers to use octahedral representation as the default format for importing meshes Updated ShaderGLES2 to support 64 bit version codes as we hit the limit of the 32-bit integer that was previously used as a bitset to store enabled/disabled flags
2021-03-08 18:58:13 +01:00
<constant name="ARRAY_FLAG_USE_OCTAHEDRAL_COMPRESSION" value="2097152" enum="ArrayFormat">
Flag used to mark that the array uses an octahedral representation of normal and tangent vectors rather than cartesian.
</constant>
<constant name="ARRAY_COMPRESS_DEFAULT" value="2194432" enum="ArrayFormat">
Used to set flags [constant ARRAY_COMPRESS_NORMAL], [constant ARRAY_COMPRESS_TANGENT], [constant ARRAY_COMPRESS_COLOR], [constant ARRAY_COMPRESS_TEX_UV], [constant ARRAY_COMPRESS_TEX_UV2], [constant ARRAY_COMPRESS_WEIGHTS], and [constant ARRAY_FLAG_USE_OCTAHEDRAL_COMPRESSION] quickly.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="PRIMITIVE_POINTS" value="0" enum="PrimitiveType">
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Primitive to draw consists of points.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="PRIMITIVE_LINES" value="1" enum="PrimitiveType">
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Primitive to draw consists of lines.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="PRIMITIVE_LINE_STRIP" value="2" enum="PrimitiveType">
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Primitive to draw consists of a line strip from start to end.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="PRIMITIVE_LINE_LOOP" value="3" enum="PrimitiveType">
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Primitive to draw consists of a line loop (a line strip with a line between the last and the first vertex).
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="PRIMITIVE_TRIANGLES" value="4" enum="PrimitiveType">
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Primitive to draw consists of triangles.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="PRIMITIVE_TRIANGLE_STRIP" value="5" enum="PrimitiveType">
Fix typos in code and docs with codespell Using v1.11.0 from https://github.com/lucasdemarchi/codespell
2018-01-18 21:37:17 +01:00
Primitive to draw consists of a triangle strip (the last 3 vertices are always combined to make a triangle).
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="PRIMITIVE_TRIANGLE_FAN" value="6" enum="PrimitiveType">
Fix typos in code and docs with codespell Using v1.11.0 from https://github.com/lucasdemarchi/codespell
2018-01-18 21:37:17 +01:00
Primitive to draw consists of a triangle strip (the last 2 vertices are always combined with the first to make a triangle).
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="PRIMITIVE_MAX" value="7" enum="PrimitiveType">
doc: Complete and harmonize all _MAX constant descriptions
2019-06-27 11:10:53 +02:00
Represents the size of the [enum PrimitiveType] enum.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="BLEND_SHAPE_MODE_NORMALIZED" value="0" enum="BlendShapeMode">
Finish documenting VisualServer
2020-01-06 00:36:50 +01:00
Blend shapes are normalized.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="BLEND_SHAPE_MODE_RELATIVE" value="1" enum="BlendShapeMode">
Finish documenting VisualServer
2020-01-06 00:36:50 +01:00
Blend shapes are relative to base weight.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="LIGHT_DIRECTIONAL" value="0" enum="LightType">
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Is a directional (sun) light.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="LIGHT_OMNI" value="1" enum="LightType">
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-22 01:04:47 +02:00
Is an omni light.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="LIGHT_SPOT" value="2" enum="LightType">
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-22 01:04:47 +02:00
Is a spot light.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="LIGHT_PARAM_ENERGY" value="0" enum="LightParam">
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
The light's energy.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
Add soft shadows to the CPU lightmapper Adds the "light_size" property to Lights. It's only considered in baked lightmaps for soft shadowing purposes.
2021-07-05 15:55:52 +02:00
<constant name="LIGHT_PARAM_INDIRECT_ENERGY" value="1" enum="LightParam">
Secondary multiplier used with indirect light (light bounces).
</constant>
<constant name="LIGHT_PARAM_SIZE" value="2" enum="LightParam">
The light's size, currently only used for soft shadows in baked lightmaps.
</constant>
<constant name="LIGHT_PARAM_SPECULAR" value="3" enum="LightParam">
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
The light's influence on specularity.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
Add soft shadows to the CPU lightmapper Adds the "light_size" property to Lights. It's only considered in baked lightmaps for soft shadowing purposes.
2021-07-05 15:55:52 +02:00
<constant name="LIGHT_PARAM_RANGE" value="4" enum="LightParam">
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
The light's range.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
Add soft shadows to the CPU lightmapper Adds the "light_size" property to Lights. It's only considered in baked lightmaps for soft shadowing purposes.
2021-07-05 15:55:52 +02:00
<constant name="LIGHT_PARAM_ATTENUATION" value="5" enum="LightParam">
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
The light's attenuation.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
Add soft shadows to the CPU lightmapper Adds the "light_size" property to Lights. It's only considered in baked lightmaps for soft shadowing purposes.
2021-07-05 15:55:52 +02:00
<constant name="LIGHT_PARAM_SPOT_ANGLE" value="6" enum="LightParam">
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
The spotlight's angle.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
Add soft shadows to the CPU lightmapper Adds the "light_size" property to Lights. It's only considered in baked lightmaps for soft shadowing purposes.
2021-07-05 15:55:52 +02:00
<constant name="LIGHT_PARAM_SPOT_ATTENUATION" value="7" enum="LightParam">
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
The spotlight's attenuation.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
Add soft shadows to the CPU lightmapper Adds the "light_size" property to Lights. It's only considered in baked lightmaps for soft shadowing purposes.
2021-07-05 15:55:52 +02:00
<constant name="LIGHT_PARAM_CONTACT_SHADOW_SIZE" value="8" enum="LightParam">
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Scales the shadow color.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
Add soft shadows to the CPU lightmapper Adds the "light_size" property to Lights. It's only considered in baked lightmaps for soft shadowing purposes.
2021-07-05 15:55:52 +02:00
<constant name="LIGHT_PARAM_SHADOW_MAX_DISTANCE" value="9" enum="LightParam">
Finish documenting VisualServer
2020-01-06 00:36:50 +01:00
Max distance that shadows will be rendered.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
Add soft shadows to the CPU lightmapper Adds the "light_size" property to Lights. It's only considered in baked lightmaps for soft shadowing purposes.
2021-07-05 15:55:52 +02:00
<constant name="LIGHT_PARAM_SHADOW_SPLIT_1_OFFSET" value="10" enum="LightParam">
Finish documenting VisualServer
2020-01-06 00:36:50 +01:00
Proportion of shadow atlas occupied by the first split.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
Add soft shadows to the CPU lightmapper Adds the "light_size" property to Lights. It's only considered in baked lightmaps for soft shadowing purposes.
2021-07-05 15:55:52 +02:00
<constant name="LIGHT_PARAM_SHADOW_SPLIT_2_OFFSET" value="11" enum="LightParam">
Finish documenting VisualServer
2020-01-06 00:36:50 +01:00
Proportion of shadow atlas occupied by the second split.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
Add soft shadows to the CPU lightmapper Adds the "light_size" property to Lights. It's only considered in baked lightmaps for soft shadowing purposes.
2021-07-05 15:55:52 +02:00
<constant name="LIGHT_PARAM_SHADOW_SPLIT_3_OFFSET" value="12" enum="LightParam">
Finish documenting VisualServer
2020-01-06 00:36:50 +01:00
Proportion of shadow atlas occupied by the third split. The fourth split occupies the rest.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
Add soft shadows to the CPU lightmapper Adds the "light_size" property to Lights. It's only considered in baked lightmaps for soft shadowing purposes.
2021-07-05 15:55:52 +02:00
<constant name="LIGHT_PARAM_SHADOW_NORMAL_BIAS" value="13" enum="LightParam">
Finish documenting VisualServer
2020-01-06 00:36:50 +01:00
Normal bias used to offset shadow lookup by object normal. Can be used to fix self-shadowing artifacts.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
Add soft shadows to the CPU lightmapper Adds the "light_size" property to Lights. It's only considered in baked lightmaps for soft shadowing purposes.
2021-07-05 15:55:52 +02:00
<constant name="LIGHT_PARAM_SHADOW_BIAS" value="14" enum="LightParam">
Finish documenting VisualServer
2020-01-06 00:36:50 +01:00
Bias the shadow lookup to fix self-shadowing artifacts.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
Add soft shadows to the CPU lightmapper Adds the "light_size" property to Lights. It's only considered in baked lightmaps for soft shadowing purposes.
2021-07-05 15:55:52 +02:00
<constant name="LIGHT_PARAM_SHADOW_BIAS_SPLIT_SCALE" value="15" enum="LightParam">
Finish documenting VisualServer
2020-01-06 00:36:50 +01:00
Increases bias on further splits to fix self-shadowing that only occurs far away from the camera.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
Add soft shadows to the CPU lightmapper Adds the "light_size" property to Lights. It's only considered in baked lightmaps for soft shadowing purposes.
2021-07-05 15:55:52 +02:00
<constant name="LIGHT_PARAM_MAX" value="16" enum="LightParam">
doc: Complete and harmonize all _MAX constant descriptions
2019-06-27 11:10:53 +02:00
Represents the size of the [enum LightParam] enum.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
Disable lights for objects with baked lighting Don't apply lighting to objects when they have a lightmap texture and the light is set to BAKE_ALL. This prevents applying the same direct light twice on the same object and makes setting up scenes with mixed lighting much easier.
2020-08-30 20:16:24 +02:00
<constant name="LIGHT_BAKE_DISABLED" value="0" enum="LightBakeMode">
</constant>
<constant name="LIGHT_BAKE_INDIRECT" value="1" enum="LightBakeMode">
</constant>
<constant name="LIGHT_BAKE_ALL" value="2" enum="LightBakeMode">
</constant>
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<constant name="LIGHT_OMNI_SHADOW_DUAL_PARABOLOID" value="0" enum="LightOmniShadowMode">
Finish documenting VisualServer
2020-01-06 00:36:50 +01:00
Use a dual paraboloid shadow map for omni lights.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</constant>
<constant name="LIGHT_OMNI_SHADOW_CUBE" value="1" enum="LightOmniShadowMode">
Finish documenting VisualServer
2020-01-06 00:36:50 +01:00
Use a cubemap shadow map for omni lights. Slower but better quality than dual paraboloid.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</constant>
<constant name="LIGHT_OMNI_SHADOW_DETAIL_VERTICAL" value="0" enum="LightOmniShadowDetail">
Finish documenting VisualServer
2020-01-06 00:36:50 +01:00
Use more detail vertically when computing shadow map.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</constant>
<constant name="LIGHT_OMNI_SHADOW_DETAIL_HORIZONTAL" value="1" enum="LightOmniShadowDetail">
Finish documenting VisualServer
2020-01-06 00:36:50 +01:00
Use more detail horizontally when computing shadow map.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</constant>
<constant name="LIGHT_DIRECTIONAL_SHADOW_ORTHOGONAL" value="0" enum="LightDirectionalShadowMode">
Finish documenting VisualServer
2020-01-06 00:36:50 +01:00
Use orthogonal shadow projection for directional light.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</constant>
<constant name="LIGHT_DIRECTIONAL_SHADOW_PARALLEL_2_SPLITS" value="1" enum="LightDirectionalShadowMode">
Finish documenting VisualServer
2020-01-06 00:36:50 +01:00
Use 2 splits for shadow projection when using directional light.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</constant>
<constant name="LIGHT_DIRECTIONAL_SHADOW_PARALLEL_4_SPLITS" value="2" enum="LightDirectionalShadowMode">
Finish documenting VisualServer
2020-01-06 00:36:50 +01:00
Use 4 splits for shadow projection when using directional light.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</constant>
<constant name="LIGHT_DIRECTIONAL_SHADOW_DEPTH_RANGE_STABLE" value="0" enum="LightDirectionalShadowDepthRangeMode">
Finish documenting VisualServer
2020-01-06 00:36:50 +01:00
Keeps shadows stable as camera moves but has lower effective resolution.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</constant>
<constant name="LIGHT_DIRECTIONAL_SHADOW_DEPTH_RANGE_OPTIMIZED" value="1" enum="LightDirectionalShadowDepthRangeMode">
Finish documenting VisualServer
2020-01-06 00:36:50 +01:00
Optimize use of shadow maps, increasing the effective resolution. But may result in shadows moving or flickering slightly.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="VIEWPORT_UPDATE_DISABLED" value="0" enum="ViewportUpdateMode">
Finish documenting VisualServer
2020-01-06 00:36:50 +01:00
Do not update the viewport.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="VIEWPORT_UPDATE_ONCE" value="1" enum="ViewportUpdateMode">
Finish documenting VisualServer
2020-01-06 00:36:50 +01:00
Update the viewport once then set to disabled.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="VIEWPORT_UPDATE_WHEN_VISIBLE" value="2" enum="ViewportUpdateMode">
Finish documenting VisualServer
2020-01-06 00:36:50 +01:00
Update the viewport whenever it is visible.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="VIEWPORT_UPDATE_ALWAYS" value="3" enum="ViewportUpdateMode">
Finish documenting VisualServer
2020-01-06 00:36:50 +01:00
Always update the viewport.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="VIEWPORT_CLEAR_ALWAYS" value="0" enum="ViewportClearMode">
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
The viewport is always cleared before drawing.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="VIEWPORT_CLEAR_NEVER" value="1" enum="ViewportClearMode">
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
The viewport is never cleared before drawing.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="VIEWPORT_CLEAR_ONLY_NEXT_FRAME" value="2" enum="ViewportClearMode">
doc: Replace all [code]CONSTANT[/code] by new [constant CONSTANT] hyperlinks
2019-06-27 12:34:26 +02:00
The viewport is cleared once, then the clear mode is set to [constant VIEWPORT_CLEAR_NEVER].
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="VIEWPORT_MSAA_DISABLED" value="0" enum="ViewportMSAA">
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Multisample antialiasing is disabled.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="VIEWPORT_MSAA_2X" value="1" enum="ViewportMSAA">
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-22 01:04:47 +02:00
Multisample antialiasing is set to 2×.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="VIEWPORT_MSAA_4X" value="2" enum="ViewportMSAA">
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-22 01:04:47 +02:00
Multisample antialiasing is set to 4×.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="VIEWPORT_MSAA_8X" value="3" enum="ViewportMSAA">
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-22 01:04:47 +02:00
Multisample antialiasing is set to 8×.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="VIEWPORT_MSAA_16X" value="4" enum="ViewportMSAA">
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-22 01:04:47 +02:00
Multisample antialiasing is set to 16×.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
Add special external MSAA modes for GLES2 Rift S/Quest and OpenXR optimisation
2019-11-10 09:30:20 +01:00
<constant name="VIEWPORT_MSAA_EXT_2X" value="5" enum="ViewportMSAA">
Rename External MSAA to AndroidVR MSAA A new external MSAA setting was introduced in https://github.com/godotengine/godot/pull/33518 that fixed issues on GLES2 and Oculus Mobile VR. To avoid misunderstanding it was suggested by @BastiaanOlij and discussed on discord to rename it to AndroidVR.
2019-11-16 15:36:43 +01:00
Multisample antialiasing is set to 2× on external texture. Special mode for GLES2 Android VR (Oculus Quest and Go).
Add special external MSAA modes for GLES2 Rift S/Quest and OpenXR optimisation
2019-11-10 09:30:20 +01:00
</constant>
<constant name="VIEWPORT_MSAA_EXT_4X" value="6" enum="ViewportMSAA">
Rename External MSAA to AndroidVR MSAA A new external MSAA setting was introduced in https://github.com/godotengine/godot/pull/33518 that fixed issues on GLES2 and Oculus Mobile VR. To avoid misunderstanding it was suggested by @BastiaanOlij and discussed on discord to rename it to AndroidVR.
2019-11-16 15:36:43 +01:00
Multisample antialiasing is set to 4× on external texture. Special mode for GLES2 Android VR (Oculus Quest and Go).
Add special external MSAA modes for GLES2 Rift S/Quest and OpenXR optimisation
2019-11-10 09:30:20 +01:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="VIEWPORT_USAGE_2D" value="0" enum="ViewportUsage">
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
The Viewport does not render 3D but samples.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="VIEWPORT_USAGE_2D_NO_SAMPLING" value="1" enum="ViewportUsage">
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
The Viewport does not render 3D and does not sample.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="VIEWPORT_USAGE_3D" value="2" enum="ViewportUsage">
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
The Viewport renders 3D with effects.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="VIEWPORT_USAGE_3D_NO_EFFECTS" value="3" enum="ViewportUsage">
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
The Viewport renders 3D but without effects.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="VIEWPORT_RENDER_INFO_OBJECTS_IN_FRAME" value="0" enum="ViewportRenderInfo">
Finish documenting VisualServer
2020-01-06 00:36:50 +01:00
Number of objects drawn in a single frame.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="VIEWPORT_RENDER_INFO_VERTICES_IN_FRAME" value="1" enum="ViewportRenderInfo">
Finish documenting VisualServer
2020-01-06 00:36:50 +01:00
Number of vertices drawn in a single frame.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="VIEWPORT_RENDER_INFO_MATERIAL_CHANGES_IN_FRAME" value="2" enum="ViewportRenderInfo">
Finish documenting VisualServer
2020-01-06 00:36:50 +01:00
Number of material changes during this frame.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="VIEWPORT_RENDER_INFO_SHADER_CHANGES_IN_FRAME" value="3" enum="ViewportRenderInfo">
Finish documenting VisualServer
2020-01-06 00:36:50 +01:00
Number of shader changes during this frame.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="VIEWPORT_RENDER_INFO_SURFACE_CHANGES_IN_FRAME" value="4" enum="ViewportRenderInfo">
Finish documenting VisualServer
2020-01-06 00:36:50 +01:00
Number of surface changes during this frame.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="VIEWPORT_RENDER_INFO_DRAW_CALLS_IN_FRAME" value="5" enum="ViewportRenderInfo">
Finish documenting VisualServer
2020-01-06 00:36:50 +01:00
Number of draw calls during this frame.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
Add frame diagnostics for GLES2 Batch renderer Added project setting to enable / disable print frame diagnostics every 10 seconds. This prints out a list of batches and info, which is useful to optimize games and identify performance problems.
2020-04-17 09:44:12 +02:00
<constant name="VIEWPORT_RENDER_INFO_2D_ITEMS_IN_FRAME" value="6" enum="ViewportRenderInfo">
Number of 2d items drawn this frame.
</constant>
<constant name="VIEWPORT_RENDER_INFO_2D_DRAW_CALLS_IN_FRAME" value="7" enum="ViewportRenderInfo">
Number of 2d draw calls during this frame.
</constant>
<constant name="VIEWPORT_RENDER_INFO_MAX" value="8" enum="ViewportRenderInfo">
doc: Complete and harmonize all _MAX constant descriptions
2019-06-27 11:10:53 +02:00
Represents the size of the [enum ViewportRenderInfo] enum.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="VIEWPORT_DEBUG_DRAW_DISABLED" value="0" enum="ViewportDebugDraw">
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Debug draw is disabled. Default setting.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="VIEWPORT_DEBUG_DRAW_UNSHADED" value="1" enum="ViewportDebugDraw">
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Debug draw sets objects to unshaded.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="VIEWPORT_DEBUG_DRAW_OVERDRAW" value="2" enum="ViewportDebugDraw">
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Overwrites clear color to [code](0,0,0,0)[/code].
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="VIEWPORT_DEBUG_DRAW_WIREFRAME" value="3" enum="ViewportDebugDraw">
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Debug draw draws objects in wireframe.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="SCENARIO_DEBUG_DISABLED" value="0" enum="ScenarioDebugMode">
Finish documenting VisualServer
2020-01-06 00:36:50 +01:00
Do not use a debug mode.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="SCENARIO_DEBUG_WIREFRAME" value="1" enum="ScenarioDebugMode">
Finish documenting VisualServer
2020-01-06 00:36:50 +01:00
Draw all objects as wireframe models.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="SCENARIO_DEBUG_OVERDRAW" value="2" enum="ScenarioDebugMode">
Finish documenting VisualServer
2020-01-06 00:36:50 +01:00
Draw all objects in a way that displays how much overdraw is occurring. Overdraw occurs when a section of pixels is drawn and shaded and then another object covers it up. To optimize a scene, you should reduce overdraw.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="SCENARIO_DEBUG_SHADELESS" value="3" enum="ScenarioDebugMode">
Finish documenting VisualServer
2020-01-06 00:36:50 +01:00
Draw all objects without shading. Equivalent to setting all objects shaders to [code]unshaded[/code].
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="INSTANCE_NONE" value="0" enum="InstanceType">
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
The instance does not have a type.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="INSTANCE_MESH" value="1" enum="InstanceType">
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
The instance is a mesh.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="INSTANCE_MULTIMESH" value="2" enum="InstanceType">
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
The instance is a multimesh.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="INSTANCE_IMMEDIATE" value="3" enum="InstanceType">
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
The instance is an immediate geometry.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="INSTANCE_PARTICLES" value="4" enum="InstanceType">
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
The instance is a particle emitter.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="INSTANCE_LIGHT" value="5" enum="InstanceType">
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
The instance is a light.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="INSTANCE_REFLECTION_PROBE" value="6" enum="InstanceType">
Document most VisualServer functions
2020-01-05 09:33:16 +01:00
The instance is a reflection probe.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="INSTANCE_GI_PROBE" value="7" enum="InstanceType">
Document most VisualServer functions
2020-01-05 09:33:16 +01:00
The instance is a GI probe.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
Bind TextEdit.deselect and update documentation
2017-12-16 20:34:16 +01:00
<constant name="INSTANCE_LIGHTMAP_CAPTURE" value="8" enum="InstanceType">
Document most VisualServer functions
2020-01-05 09:33:16 +01:00
The instance is a lightmap capture.
Bind TextEdit.deselect and update documentation
2017-12-16 20:34:16 +01:00
</constant>
<constant name="INSTANCE_MAX" value="9" enum="InstanceType">
doc: Complete and harmonize all _MAX constant descriptions
2019-06-27 11:10:53 +02:00
Represents the size of the [enum InstanceType] enum.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="INSTANCE_GEOMETRY_MASK" value="30" enum="InstanceType">
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
A combination of the flags of geometry instances (mesh, multimesh, immediate and particles).
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<constant name="INSTANCE_FLAG_USE_BAKED_LIGHT" value="0" enum="InstanceFlags">
Updated many VisualServer functions
2020-01-04 08:24:40 +01:00
Allows the instance to be used in baked lighting.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</constant>
doc: Sync classref with current source
2018-08-21 00:35:30 +02:00
<constant name="INSTANCE_FLAG_DRAW_NEXT_FRAME_IF_VISIBLE" value="1" enum="InstanceFlags">
Updated many VisualServer functions
2020-01-04 08:24:40 +01:00
When set, manually requests to draw geometry on next frame.
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
</constant>
<constant name="INSTANCE_FLAG_MAX" value="2" enum="InstanceFlags">
doc: Complete and harmonize all _MAX constant descriptions
2019-06-27 11:10:53 +02:00
Represents the size of the [enum InstanceFlags] enum.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</constant>
<constant name="SHADOW_CASTING_SETTING_OFF" value="0" enum="ShadowCastingSetting">
Updated many VisualServer functions
2020-01-04 08:24:40 +01:00
Disable shadows from this instance.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</constant>
<constant name="SHADOW_CASTING_SETTING_ON" value="1" enum="ShadowCastingSetting">
Updated many VisualServer functions
2020-01-04 08:24:40 +01:00
Cast shadows from this instance.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</constant>
<constant name="SHADOW_CASTING_SETTING_DOUBLE_SIDED" value="2" enum="ShadowCastingSetting">
Updated many VisualServer functions
2020-01-04 08:24:40 +01:00
Disable backface culling when rendering the shadow of the object. This is slightly slower but may result in more correct shadows.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</constant>
<constant name="SHADOW_CASTING_SETTING_SHADOWS_ONLY" value="3" enum="ShadowCastingSetting">
Updated many VisualServer functions
2020-01-04 08:24:40 +01:00
Only render the shadows from the object. The object itself will not be drawn.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="NINE_PATCH_STRETCH" value="0" enum="NinePatchAxisMode">
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
The nine patch gets stretched where needed.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="NINE_PATCH_TILE" value="1" enum="NinePatchAxisMode">
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
The nine patch gets filled with tiles where needed.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="NINE_PATCH_TILE_FIT" value="2" enum="NinePatchAxisMode">
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
The nine patch gets filled with tiles where needed and stretches them a bit if needed.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="CANVAS_LIGHT_MODE_ADD" value="0" enum="CanvasLightMode">
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Adds light color additive to the canvas.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="CANVAS_LIGHT_MODE_SUB" value="1" enum="CanvasLightMode">
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Adds light color subtractive to the canvas.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="CANVAS_LIGHT_MODE_MIX" value="2" enum="CanvasLightMode">
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
The light adds color depending on transparency.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="CANVAS_LIGHT_MODE_MASK" value="3" enum="CanvasLightMode">
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
The light adds color depending on mask.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="CANVAS_LIGHT_FILTER_NONE" value="0" enum="CanvasLightShadowFilter">
Finish documenting VisualServer
2020-01-06 00:36:50 +01:00
Do not apply a filter to canvas light shadows.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="CANVAS_LIGHT_FILTER_PCF3" value="1" enum="CanvasLightShadowFilter">
Finish documenting VisualServer
2020-01-06 00:36:50 +01:00
Use PCF3 filtering to filter canvas light shadows.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="CANVAS_LIGHT_FILTER_PCF5" value="2" enum="CanvasLightShadowFilter">
Finish documenting VisualServer
2020-01-06 00:36:50 +01:00
Use PCF5 filtering to filter canvas light shadows.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="CANVAS_LIGHT_FILTER_PCF7" value="3" enum="CanvasLightShadowFilter">
Finish documenting VisualServer
2020-01-06 00:36:50 +01:00
Use PCF7 filtering to filter canvas light shadows.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="CANVAS_LIGHT_FILTER_PCF9" value="4" enum="CanvasLightShadowFilter">
Finish documenting VisualServer
2020-01-06 00:36:50 +01:00
Use PCF9 filtering to filter canvas light shadows.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="CANVAS_LIGHT_FILTER_PCF13" value="5" enum="CanvasLightShadowFilter">
Finish documenting VisualServer
2020-01-06 00:36:50 +01:00
Use PCF13 filtering to filter canvas light shadows.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="CANVAS_OCCLUDER_POLYGON_CULL_DISABLED" value="0" enum="CanvasOccluderPolygonCullMode">
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Culling of the canvas occluder is disabled.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="CANVAS_OCCLUDER_POLYGON_CULL_CLOCKWISE" value="1" enum="CanvasOccluderPolygonCullMode">
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Culling of the canvas occluder is clockwise.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="CANVAS_OCCLUDER_POLYGON_CULL_COUNTER_CLOCKWISE" value="2" enum="CanvasOccluderPolygonCullMode">
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
Culling of the canvas occluder is counterclockwise.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="INFO_OBJECTS_IN_FRAME" value="0" enum="RenderInfo">
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
The amount of objects in the frame.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="INFO_VERTICES_IN_FRAME" value="1" enum="RenderInfo">
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
The amount of vertices in the frame.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="INFO_MATERIAL_CHANGES_IN_FRAME" value="2" enum="RenderInfo">
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
The amount of modified materials in the frame.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="INFO_SHADER_CHANGES_IN_FRAME" value="3" enum="RenderInfo">
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
The amount of shader rebinds in the frame.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="INFO_SURFACE_CHANGES_IN_FRAME" value="4" enum="RenderInfo">
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
The amount of surface changes in the frame.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="INFO_DRAW_CALLS_IN_FRAME" value="5" enum="RenderInfo">
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
The amount of draw calls in frame.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
Add frame diagnostics for GLES2 Batch renderer Added project setting to enable / disable print frame diagnostics every 10 seconds. This prints out a list of batches and info, which is useful to optimize games and identify performance problems.
2020-04-17 09:44:12 +02:00
<constant name="INFO_2D_ITEMS_IN_FRAME" value="6" enum="RenderInfo">
The amount of 2d items in the frame.
</constant>
<constant name="INFO_2D_DRAW_CALLS_IN_FRAME" value="7" enum="RenderInfo">
The amount of 2d draw calls in frame.
</constant>
<constant name="INFO_USAGE_VIDEO_MEM_TOTAL" value="8" enum="RenderInfo">
doc: Proofread and complete various nodes All 100% completed: MainLoop, Node, Object, Path, Performance, Reference, Resource, SceneState, SceneTree, UndoRedo. Also fixed some en_GB occurrences as the reference spelling is en_US.
2019-06-26 15:57:13 +02:00
Unimplemented in the GLES2 and GLES3 rendering backends, always returns 0.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
Add frame diagnostics for GLES2 Batch renderer Added project setting to enable / disable print frame diagnostics every 10 seconds. This prints out a list of batches and info, which is useful to optimize games and identify performance problems.
2020-04-17 09:44:12 +02:00
<constant name="INFO_VIDEO_MEM_USED" value="9" enum="RenderInfo">
doc: Proofread and complete various nodes All 100% completed: MainLoop, Node, Object, Path, Performance, Reference, Resource, SceneState, SceneTree, UndoRedo. Also fixed some en_GB occurrences as the reference spelling is en_US.
2019-06-26 15:57:13 +02:00
The amount of video memory used, i.e. texture and vertex memory combined.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
Add frame diagnostics for GLES2 Batch renderer Added project setting to enable / disable print frame diagnostics every 10 seconds. This prints out a list of batches and info, which is useful to optimize games and identify performance problems.
2020-04-17 09:44:12 +02:00
<constant name="INFO_TEXTURE_MEM_USED" value="10" enum="RenderInfo">
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
The amount of texture memory used.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
Add frame diagnostics for GLES2 Batch renderer Added project setting to enable / disable print frame diagnostics every 10 seconds. This prints out a list of batches and info, which is useful to optimize games and identify performance problems.
2020-04-17 09:44:12 +02:00
<constant name="INFO_VERTEX_MEM_USED" value="11" enum="RenderInfo">
Added documentation for VisualServer
2017-11-26 16:37:37 +01:00
The amount of vertex memory used.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="FEATURE_SHADERS" value="0" enum="Features">
Finish documenting VisualServer
2020-01-06 00:36:50 +01:00
Hardware supports shaders. This enum is currently unused in Godot 3.x.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="FEATURE_MULTITHREADED" value="1" enum="Features">
Finish documenting VisualServer
2020-01-06 00:36:50 +01:00
Hardware supports multithreading. This enum is currently unused in Godot 3.x.
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</constant>
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<constant name="MULTIMESH_TRANSFORM_2D" value="0" enum="MultimeshTransformFormat">
Document most VisualServer functions
2020-01-05 09:33:16 +01:00
Use [Transform2D] to store MultiMesh transform.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</constant>
<constant name="MULTIMESH_TRANSFORM_3D" value="1" enum="MultimeshTransformFormat">
Document most VisualServer functions
2020-01-05 09:33:16 +01:00
Use [Transform] to store MultiMesh transform.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</constant>
<constant name="MULTIMESH_COLOR_NONE" value="0" enum="MultimeshColorFormat">
Document most VisualServer functions
2020-01-05 09:33:16 +01:00
MultiMesh does not use per-instance color.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</constant>
<constant name="MULTIMESH_COLOR_8BIT" value="1" enum="MultimeshColorFormat">
Document most VisualServer functions
2020-01-05 09:33:16 +01:00
MultiMesh color uses 8 bits per component. This packs the color into a single float.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</constant>
<constant name="MULTIMESH_COLOR_FLOAT" value="2" enum="MultimeshColorFormat">
Document most VisualServer functions
2020-01-05 09:33:16 +01:00
MultiMesh color uses a float per channel.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</constant>
doc: Fix wrong references found by Sphinx and new makerst.py
2019-01-07 11:46:26 +01:00
<constant name="MULTIMESH_CUSTOM_DATA_NONE" value="0" enum="MultimeshCustomDataFormat">
Document most VisualServer functions
2020-01-05 09:33:16 +01:00
MultiMesh does not use custom data.
doc: Fix wrong references found by Sphinx and new makerst.py
2019-01-07 11:46:26 +01:00
</constant>
<constant name="MULTIMESH_CUSTOM_DATA_8BIT" value="1" enum="MultimeshCustomDataFormat">
Document most VisualServer functions
2020-01-05 09:33:16 +01:00
MultiMesh custom data uses 8 bits per component. This packs the 4-component custom data into a single float.
doc: Fix wrong references found by Sphinx and new makerst.py
2019-01-07 11:46:26 +01:00
</constant>
<constant name="MULTIMESH_CUSTOM_DATA_FLOAT" value="2" enum="MultimeshCustomDataFormat">
Document most VisualServer functions
2020-01-05 09:33:16 +01:00
MultiMesh custom data uses a float per component.
doc: Fix wrong references found by Sphinx and new makerst.py
2019-01-07 11:46:26 +01:00
</constant>
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<constant name="REFLECTION_PROBE_UPDATE_ONCE" value="0" enum="ReflectionProbeUpdateMode">
Finish documenting VisualServer
2020-01-06 00:36:50 +01:00
Reflection probe will update reflections once and then stop.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</constant>
<constant name="REFLECTION_PROBE_UPDATE_ALWAYS" value="1" enum="ReflectionProbeUpdateMode">
Finish documenting VisualServer
2020-01-06 00:36:50 +01:00
Reflection probe will update each frame. This mode is necessary to capture moving objects.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</constant>
<constant name="PARTICLES_DRAW_ORDER_INDEX" value="0" enum="ParticlesDrawOrder">
Finish documenting VisualServer
2020-01-06 00:36:50 +01:00
Draw particles in the order that they appear in the particles array.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</constant>
<constant name="PARTICLES_DRAW_ORDER_LIFETIME" value="1" enum="ParticlesDrawOrder">
Finish documenting VisualServer
2020-01-06 00:36:50 +01:00
Sort particles based on their lifetime.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</constant>
<constant name="PARTICLES_DRAW_ORDER_VIEW_DEPTH" value="2" enum="ParticlesDrawOrder">
Finish documenting VisualServer
2020-01-06 00:36:50 +01:00
Sort particles based on their distance to the camera.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</constant>
<constant name="ENV_BG_CLEAR_COLOR" value="0" enum="EnvironmentBG">
Finish documenting VisualServer
2020-01-06 00:36:50 +01:00
Use the clear color as background.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</constant>
<constant name="ENV_BG_COLOR" value="1" enum="EnvironmentBG">
Finish documenting VisualServer
2020-01-06 00:36:50 +01:00
Use a specified color as the background.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</constant>
<constant name="ENV_BG_SKY" value="2" enum="EnvironmentBG">
Finish documenting VisualServer
2020-01-06 00:36:50 +01:00
Use a sky resource for the background.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</constant>
<constant name="ENV_BG_COLOR_SKY" value="3" enum="EnvironmentBG">
Finish documenting VisualServer
2020-01-06 00:36:50 +01:00
Use a custom color for background, but use a sky for shading and reflections.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</constant>
<constant name="ENV_BG_CANVAS" value="4" enum="EnvironmentBG">
Finish documenting VisualServer
2020-01-06 00:36:50 +01:00
Use a specified canvas layer as the background. This can be useful for instantiating a 2D scene in a 3D world.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</constant>
<constant name="ENV_BG_KEEP" value="5" enum="EnvironmentBG">
Finish documenting VisualServer
2020-01-06 00:36:50 +01:00
Do not clear the background, use whatever was rendered last frame as the background.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</constant>
Adding a new Camera Server implementation to Godot. This is a new singleton where camera sources such as webcams or cameras on a mobile phone can register themselves with the Server. Other parts of Godot can interact with this to obtain images from the camera as textures. This work includes additions to the Visual Server to use this functionality to present the camera image in the background. This is specifically targetted at AR applications.
2017-08-20 16:17:24 +02:00
<constant name="ENV_BG_MAX" value="7" enum="EnvironmentBG">
doc: Complete and harmonize all _MAX constant descriptions
2019-06-27 11:10:53 +02:00
Represents the size of the [enum EnvironmentBG] enum.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</constant>
<constant name="ENV_DOF_BLUR_QUALITY_LOW" value="0" enum="EnvironmentDOFBlurQuality">
Finish documenting VisualServer
2020-01-06 00:36:50 +01:00
Use lowest blur quality. Fastest, but may look bad.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</constant>
<constant name="ENV_DOF_BLUR_QUALITY_MEDIUM" value="1" enum="EnvironmentDOFBlurQuality">
Finish documenting VisualServer
2020-01-06 00:36:50 +01:00
Use medium blur quality.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</constant>
<constant name="ENV_DOF_BLUR_QUALITY_HIGH" value="2" enum="EnvironmentDOFBlurQuality">
Finish documenting VisualServer
2020-01-06 00:36:50 +01:00
Used highest blur quality. Looks the best, but is the slowest.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</constant>
<constant name="GLOW_BLEND_MODE_ADDITIVE" value="0" enum="EnvironmentGlowBlendMode">
Finish documenting VisualServer
2020-01-06 00:36:50 +01:00
Add the effect of the glow on top of the scene.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</constant>
<constant name="GLOW_BLEND_MODE_SCREEN" value="1" enum="EnvironmentGlowBlendMode">
Finish documenting VisualServer
2020-01-06 00:36:50 +01:00
Blends the glow effect with the screen. Does not get as bright as additive.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</constant>
<constant name="GLOW_BLEND_MODE_SOFTLIGHT" value="2" enum="EnvironmentGlowBlendMode">
Finish documenting VisualServer
2020-01-06 00:36:50 +01:00
Produces a subtle color disturbance around objects.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</constant>
<constant name="GLOW_BLEND_MODE_REPLACE" value="3" enum="EnvironmentGlowBlendMode">
Finish documenting VisualServer
2020-01-06 00:36:50 +01:00
Shows the glow effect by itself without the underlying scene.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</constant>
<constant name="ENV_TONE_MAPPER_LINEAR" value="0" enum="EnvironmentToneMapper">
Improve documentation for tonemapping operators
2022-04-30 16:21:10 +02: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
2018-02-19 10:47:16 +01:00
</constant>
Update class documentation xml
2018-10-07 15:52:07 +02:00
<constant name="ENV_TONE_MAPPER_REINHARD" value="1" enum="EnvironmentToneMapper">
Improve documentation for tonemapping operators
2022-04-30 16:21:10 +02: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
2018-02-19 10:47:16 +01:00
</constant>
<constant name="ENV_TONE_MAPPER_FILMIC" value="2" enum="EnvironmentToneMapper">
Improve documentation for tonemapping operators
2022-04-30 16:21:10 +02: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
2018-02-19 10:47:16 +01:00
</constant>
<constant name="ENV_TONE_MAPPER_ACES" value="3" enum="EnvironmentToneMapper">
Improve documentation for tonemapping operators
2022-04-30 16:21:10 +02:00
Use the legacy Godot version of the Academy Color Encoding System tonemapper. Unlike [constant ENV_TONE_MAPPER_ACES_FITTED], this version of ACES does not handle bright lighting in a physically accurate way. ACES typically has a more contrasted output compared to [constant ENV_TONE_MAPPER_REINHARD] and [constant ENV_TONE_MAPPER_FILMIC].
[b]Note:[/b] This tonemapping operator will be removed in Godot 4.0 in favor of the more accurate [constant ENV_TONE_MAPPER_ACES_FITTED].
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</constant>
Add a new high quality tonemapper: ACES Fitted
2021-09-07 21:26:20 +02:00
<constant name="ENV_TONE_MAPPER_ACES_FITTED" value="4" enum="EnvironmentToneMapper">
Improve documentation for tonemapping operators
2022-04-30 16:21:10 +02: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].
Add a new high quality tonemapper: ACES Fitted
2021-09-07 21:26:20 +02:00
</constant>
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
<constant name="ENV_SSAO_QUALITY_LOW" value="0" enum="EnvironmentSSAOQuality">
doc: Sync classref with current source
2020-01-12 14:30:21 +01:00
Lowest quality of screen space ambient occlusion.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</constant>
<constant name="ENV_SSAO_QUALITY_MEDIUM" value="1" enum="EnvironmentSSAOQuality">
Finish documenting VisualServer
2020-01-06 00:36:50 +01:00
Medium quality screen space ambient occlusion.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</constant>
<constant name="ENV_SSAO_QUALITY_HIGH" value="2" enum="EnvironmentSSAOQuality">
Finish documenting VisualServer
2020-01-06 00:36:50 +01:00
Highest quality screen space ambient occlusion.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</constant>
<constant name="ENV_SSAO_BLUR_DISABLED" value="0" enum="EnvironmentSSAOBlur">
Finish documenting VisualServer
2020-01-06 00:36:50 +01:00
Disables the blur set for SSAO. Will make SSAO look noisier.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</constant>
<constant name="ENV_SSAO_BLUR_1x1" value="1" enum="EnvironmentSSAOBlur">
doc: Sync classref with current source
2020-01-12 14:30:21 +01:00
Perform a 1x1 blur on the SSAO output.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</constant>
<constant name="ENV_SSAO_BLUR_2x2" value="2" enum="EnvironmentSSAOBlur">
Finish documenting VisualServer
2020-01-06 00:36:50 +01:00
Performs a 2x2 blur on the SSAO output.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</constant>
<constant name="ENV_SSAO_BLUR_3x3" value="3" enum="EnvironmentSSAOBlur">
Finish documenting VisualServer
2020-01-06 00:36:50 +01:00
Performs a 3x3 blur on the SSAO output. Use this for smoothest SSAO.
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
</constant>
Add editor vital redraws only option When editor continuous redraws is switched off, the editor only redraws when a redraw_request was issued by an element in the scene. This works well in most situations, but when scenes have dynamic content they will continuously issue redraw_requests. This can be fine on high power desktops but can be an annoyance on lower power machines. This PR splits redraw requests into high and low priority requests, defaulting to high priority. Requests due to e.g. shaders using TIME are assigned low priority. An extra editor setting is used to record the user preference and an extra option is added to the editor spinner menu, to allow the user to select between 3 modes: * Continuous * Update all changes * Update vital changes
2021-10-05 20:05:57 +02:00
<constant name="CHANGED_PRIORITY_ANY" value="0" enum="ChangedPriority">
Used to query for any changes that request a redraw, whatever the priority.
</constant>
<constant name="CHANGED_PRIORITY_LOW" value="1" enum="ChangedPriority">
Registered changes which have low priority can be optionally prevented from causing editor redraws. Examples might include dynamic shaders (typically using the [code]TIME[/code] built-in).
</constant>
<constant name="CHANGED_PRIORITY_HIGH" value="2" enum="ChangedPriority">
Registered changes which can cause a redraw default to high priority.
</constant>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</constants>
doc: Sync classref with current source
2017-12-10 00:43:30 +01:00
</class>
Reference in a new issue Copy permalink