summaryrefslogtreecommitdiff
path: root/doc/classes
diff options
context:
space:
mode:
Diffstat (limited to 'doc/classes')
-rw-r--r--doc/classes/@GlobalScope.xml9
-rw-r--r--doc/classes/Light3D.xml3
-rw-r--r--doc/classes/RenderingServer.xml8
-rw-r--r--doc/classes/ResourceSaver.xml7
-rw-r--r--doc/classes/VisualShader.xml38
-rw-r--r--doc/classes/VisualShaderNodeVarying.xml15
-rw-r--r--doc/classes/VisualShaderNodeVaryingGetter.xml9
-rw-r--r--doc/classes/VisualShaderNodeVaryingSetter.xml9
8 files changed, 85 insertions, 13 deletions
diff --git a/doc/classes/@GlobalScope.xml b/doc/classes/@GlobalScope.xml
index 17cb50d1a4..3cfc6f3bd2 100644
--- a/doc/classes/@GlobalScope.xml
+++ b/doc/classes/@GlobalScope.xml
@@ -1284,6 +1284,9 @@
<constant name="INLINE_ALIGNMENT_TEXT_MASK" value="12" enum="InlineAlignment">
A bit mask for [code]INLINE_ALIGNMENT_TO_*[/code] alignment constants.
</constant>
+ <constant name="KEY_NONE" value="0" enum="Key">
+ Enum value which doesn't correspond to any key. This is used to initialize [enum Key] properties with a generic state.
+ </constant>
<constant name="KEY_SPECIAL" value="16777216" enum="Key">
Keycodes with this bit applied are non-printable.
</constant>
@@ -2040,6 +2043,9 @@
<constant name="KEY_MASK_GROUP_SWITCH" value="1073741824" enum="KeyModifierMask">
Group Switch key mask.
</constant>
+ <constant name="MOUSE_BUTTON_NONE" value="0" enum="MouseButton">
+ Enum value which doesn't correspond to any mouse button. This is used to initialize [enum MouseButton] properties with a generic state.
+ </constant>
<constant name="MOUSE_BUTTON_LEFT" value="1" enum="MouseButton">
Left mouse button.
</constant>
@@ -2184,6 +2190,9 @@
<constant name="JOY_AXIS_MAX" value="10" enum="JoyAxis">
The maximum number of game controller axes: OpenVR supports up to 5 Joysticks making a total of 10 axes.
</constant>
+ <constant name="MIDI_MESSAGE_NONE" value="0" enum="MIDIMessage">
+ Enum value which doesn't correspond to any MIDI message. This is used to initialize [enum MIDIMessage] properties with a generic state.
+ </constant>
<constant name="MIDI_MESSAGE_NOTE_OFF" value="8" enum="MIDIMessage">
MIDI note OFF message. See the documentation of [InputEventMIDI] for information of how to use MIDI inputs.
</constant>
diff --git a/doc/classes/Light3D.xml b/doc/classes/Light3D.xml
index 0350d09dfd..b7822f1bb0 100644
--- a/doc/classes/Light3D.xml
+++ b/doc/classes/Light3D.xml
@@ -86,9 +86,6 @@
<member name="shadow_blur" type="float" setter="set_param" getter="get_param" default="1.0">
Blurs the edges of the shadow. Can be used to hide pixel artifacts in low-resolution shadow maps. A high value can impact performance, make shadows appear grainy and can cause other unwanted artifacts. Try to keep as near default as possible.
</member>
- <member name="shadow_color" type="Color" setter="set_shadow_color" getter="get_shadow_color" default="Color(0, 0, 0, 1)">
- The color of shadows cast by this light.
- </member>
<member name="shadow_enabled" type="bool" setter="set_shadow" getter="has_shadow" default="false">
If [code]true[/code], the light will cast real-time shadows. This has a significant performance cost. Only enable shadow rendering when it makes a noticeable difference in the scene's appearance, and consider using [member distance_fade_enabled] to hide the light when far away from the [Camera3D].
</member>
diff --git a/doc/classes/RenderingServer.xml b/doc/classes/RenderingServer.xml
index ba3f5e10f5..50990b5320 100644
--- a/doc/classes/RenderingServer.xml
+++ b/doc/classes/RenderingServer.xml
@@ -1709,14 +1709,6 @@
If [code]true[/code], light will cast shadows. Equivalent to [member Light3D.shadow_enabled].
</description>
</method>
- <method name="light_set_shadow_color">
- <return type="void" />
- <argument index="0" name="light" type="RID" />
- <argument index="1" name="color" type="Color" />
- <description>
- Sets the color of the shadow cast by the light. Equivalent to [member Light3D.shadow_color].
- </description>
- </method>
<method name="lightmap_create">
<return type="RID" />
<description>
diff --git a/doc/classes/ResourceSaver.xml b/doc/classes/ResourceSaver.xml
index 3872db5ea9..a029fb9acf 100644
--- a/doc/classes/ResourceSaver.xml
+++ b/doc/classes/ResourceSaver.xml
@@ -21,15 +21,18 @@
<return type="int" enum="Error" />
<argument index="0" name="path" type="String" />
<argument index="1" name="resource" type="Resource" />
- <argument index="2" name="flags" type="int" enum="ResourceSaver.SaverFlags" default="0" />
+ <argument index="2" name="flags" type="int" default="0" />
<description>
Saves a resource to disk to the given path, using a [ResourceFormatSaver] that recognizes the resource object.
- The [code]flags[/code] bitmask can be specified to customize the save behavior.
+ The [code]flags[/code] bitmask can be specified to customize the save behavior using [enum SaverFlags] flags.
Returns [constant OK] on success.
</description>
</method>
</methods>
<constants>
+ <constant name="FLAG_NONE" value="0" enum="SaverFlags">
+ No resource saving option.
+ </constant>
<constant name="FLAG_RELATIVE_PATHS" value="1" enum="SaverFlags">
Save the resource with a path relative to the scene which uses it.
</constant>
diff --git a/doc/classes/VisualShader.xml b/doc/classes/VisualShader.xml
index 3c5a6f3a33..138aad8d47 100644
--- a/doc/classes/VisualShader.xml
+++ b/doc/classes/VisualShader.xml
@@ -20,6 +20,14 @@
Adds the specified node to the shader.
</description>
</method>
+ <method name="add_varying">
+ <return type="void" />
+ <argument index="0" name="name" type="String" />
+ <argument index="1" name="mode" type="int" enum="VisualShader.VaryingMode" />
+ <argument index="2" name="type" type="int" enum="VisualShader.VaryingType" />
+ <description>
+ </description>
+ </method>
<method name="can_connect_nodes" qualifiers="const">
<return type="bool" />
<argument index="0" name="type" type="int" enum="VisualShader.Type" />
@@ -100,6 +108,12 @@
<description>
</description>
</method>
+ <method name="has_varying" qualifiers="const">
+ <return type="bool" />
+ <argument index="0" name="name" type="String" />
+ <description>
+ </description>
+ </method>
<method name="is_node_connection" qualifiers="const">
<return type="bool" />
<argument index="0" name="type" type="int" enum="VisualShader.Type" />
@@ -119,6 +133,12 @@
Removes the specified node from the shader.
</description>
</method>
+ <method name="remove_varying">
+ <return type="void" />
+ <argument index="0" name="name" type="String" />
+ <description>
+ </description>
+ </method>
<method name="replace_node">
<return type="void" />
<argument index="0" name="type" type="int" enum="VisualShader.Type" />
@@ -182,6 +202,24 @@
<constant name="TYPE_MAX" value="10" enum="Type">
Represents the size of the [enum Type] enum.
</constant>
+ <constant name="VARYING_MODE_VERTEX_TO_FRAG_LIGHT" value="0" enum="VaryingMode">
+ </constant>
+ <constant name="VARYING_MODE_FRAG_TO_LIGHT" value="1" enum="VaryingMode">
+ </constant>
+ <constant name="VARYING_MODE_MAX" value="2" enum="VaryingMode">
+ </constant>
+ <constant name="VARYING_TYPE_FLOAT" value="0" enum="VaryingType">
+ </constant>
+ <constant name="VARYING_TYPE_VECTOR_2D" value="1" enum="VaryingType">
+ </constant>
+ <constant name="VARYING_TYPE_VECTOR_3D" value="2" enum="VaryingType">
+ </constant>
+ <constant name="VARYING_TYPE_COLOR" value="3" enum="VaryingType">
+ </constant>
+ <constant name="VARYING_TYPE_TRANSFORM" value="4" enum="VaryingType">
+ </constant>
+ <constant name="VARYING_TYPE_MAX" value="5" enum="VaryingType">
+ </constant>
<constant name="NODE_ID_INVALID" value="-1">
</constant>
<constant name="NODE_ID_OUTPUT" value="0">
diff --git a/doc/classes/VisualShaderNodeVarying.xml b/doc/classes/VisualShaderNodeVarying.xml
new file mode 100644
index 0000000000..0dbbd61f3a
--- /dev/null
+++ b/doc/classes/VisualShaderNodeVarying.xml
@@ -0,0 +1,15 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<class name="VisualShaderNodeVarying" inherits="VisualShaderNode" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
+ <brief_description>
+ </brief_description>
+ <description>
+ </description>
+ <tutorials>
+ </tutorials>
+ <members>
+ <member name="varying_name" type="String" setter="set_varying_name" getter="get_varying_name" default="&quot;[None]&quot;">
+ </member>
+ <member name="varying_type" type="int" setter="set_varying_type" getter="get_varying_type" enum="VisualShader.VaryingType" default="0">
+ </member>
+ </members>
+</class>
diff --git a/doc/classes/VisualShaderNodeVaryingGetter.xml b/doc/classes/VisualShaderNodeVaryingGetter.xml
new file mode 100644
index 0000000000..de30b18d67
--- /dev/null
+++ b/doc/classes/VisualShaderNodeVaryingGetter.xml
@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<class name="VisualShaderNodeVaryingGetter" inherits="VisualShaderNodeVarying" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
+ <brief_description>
+ </brief_description>
+ <description>
+ </description>
+ <tutorials>
+ </tutorials>
+</class>
diff --git a/doc/classes/VisualShaderNodeVaryingSetter.xml b/doc/classes/VisualShaderNodeVaryingSetter.xml
new file mode 100644
index 0000000000..57ead3d82b
--- /dev/null
+++ b/doc/classes/VisualShaderNodeVaryingSetter.xml
@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<class name="VisualShaderNodeVaryingSetter" inherits="VisualShaderNodeVarying" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
+ <brief_description>
+ </brief_description>
+ <description>
+ </description>
+ <tutorials>
+ </tutorials>
+</class>