summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorHugo Locurcio <hugo.locurcio@hugo.pro>2022-04-03 19:09:09 +0200
committerHugo Locurcio <hugo.locurcio@hugo.pro>2022-08-04 23:17:06 +0200
commitdb22b7ded04e2cf7eac1c9a05d625b8b00e2f003 (patch)
tree09e2e183a866fe53489459b5a4899b53cdfb4d94 /doc
parent80193260ff2734c368127bbc55228fa6ab3ebc2c (diff)
Rename shader parameter uniform setter/getter methods for consistency
`shader_uniform` is now consistenly used across both per-shader and per-instance shader uniform methods. This makes methods easier to find in the class reference when looking for them.
Diffstat (limited to 'doc')
-rw-r--r--doc/classes/GeometryInstance3D.xml4
-rw-r--r--doc/classes/RenderingServer.xml10
-rw-r--r--doc/classes/Shader.xml2
-rw-r--r--doc/classes/ShaderMaterial.xml4
4 files changed, 10 insertions, 10 deletions
diff --git a/doc/classes/GeometryInstance3D.xml b/doc/classes/GeometryInstance3D.xml
index c803f43fb0..365efa6761 100644
--- a/doc/classes/GeometryInstance3D.xml
+++ b/doc/classes/GeometryInstance3D.xml
@@ -9,7 +9,7 @@
<tutorials>
</tutorials>
<methods>
- <method name="get_shader_instance_uniform" qualifiers="const">
+ <method name="get_instance_shader_uniform" qualifiers="const">
<return type="Variant" />
<argument index="0" name="uniform" type="StringName" />
<description>
@@ -22,7 +22,7 @@
Overrides the bounding box of this node with a custom one. To remove it, set an [AABB] with all fields set to zero.
</description>
</method>
- <method name="set_shader_instance_uniform">
+ <method name="set_instance_shader_uniform">
<return type="void" />
<argument index="0" name="uniform" type="StringName" />
<argument index="1" name="value" type="Variant" />
diff --git a/doc/classes/RenderingServer.xml b/doc/classes/RenderingServer.xml
index 9a398b1f33..1b58b50bc7 100644
--- a/doc/classes/RenderingServer.xml
+++ b/doc/classes/RenderingServer.xml
@@ -1391,21 +1391,21 @@
Once finished with your RID, you will want to free the RID using the RenderingServer's [method free_rid] static method.
</description>
</method>
- <method name="instance_geometry_get_shader_parameter" qualifiers="const">
+ <method name="instance_geometry_get_shader_uniform" qualifiers="const">
<return type="Variant" />
<argument index="0" name="instance" type="RID" />
<argument index="1" name="parameter" type="StringName" />
<description>
</description>
</method>
- <method name="instance_geometry_get_shader_parameter_default_value" qualifiers="const">
+ <method name="instance_geometry_get_shader_uniform_default_value" qualifiers="const">
<return type="Variant" />
<argument index="0" name="instance" type="RID" />
<argument index="1" name="parameter" type="StringName" />
<description>
</description>
</method>
- <method name="instance_geometry_get_shader_parameter_list" qualifiers="const">
+ <method name="instance_geometry_get_shader_uniform_list" qualifiers="const">
<return type="Array" />
<argument index="0" name="instance" type="RID" />
<description>
@@ -1460,7 +1460,7 @@
Sets a material that will override the material for all surfaces on the mesh associated with this instance. Equivalent to [member GeometryInstance3D.material_override].
</description>
</method>
- <method name="instance_geometry_set_shader_parameter">
+ <method name="instance_geometry_set_shader_uniform">
<return type="void" />
<argument index="0" name="instance" type="RID" />
<argument index="1" name="parameter" type="StringName" />
@@ -2741,7 +2741,7 @@
<description>
</description>
</method>
- <method name="shader_get_param_list" qualifiers="const">
+ <method name="shader_get_shader_uniform_list" qualifiers="const">
<return type="Dictionary[]" />
<argument index="0" name="shader" type="RID" />
<description>
diff --git a/doc/classes/Shader.xml b/doc/classes/Shader.xml
index 10deaf1c41..1921c5b91d 100644
--- a/doc/classes/Shader.xml
+++ b/doc/classes/Shader.xml
@@ -26,7 +26,7 @@
Returns the shader mode for the shader, either [constant MODE_CANVAS_ITEM], [constant MODE_SPATIAL] or [constant MODE_PARTICLES].
</description>
</method>
- <method name="has_param" qualifiers="const">
+ <method name="has_uniform" qualifiers="const">
<return type="bool" />
<argument index="0" name="name" type="StringName" />
<description>
diff --git a/doc/classes/ShaderMaterial.xml b/doc/classes/ShaderMaterial.xml
index 672b660c34..1208b93a62 100644
--- a/doc/classes/ShaderMaterial.xml
+++ b/doc/classes/ShaderMaterial.xml
@@ -10,7 +10,7 @@
<link title="Shaders documentation index">$DOCS_URL/tutorials/shaders/index.html</link>
</tutorials>
<methods>
- <method name="get_shader_param" qualifiers="const">
+ <method name="get_shader_uniform" qualifiers="const">
<return type="Variant" />
<argument index="0" name="param" type="StringName" />
<description>
@@ -31,7 +31,7 @@
Returns the default value of the material property with given [code]name[/code].
</description>
</method>
- <method name="set_shader_param">
+ <method name="set_shader_uniform">
<return type="void" />
<argument index="0" name="param" type="StringName" />
<argument index="1" name="value" type="Variant" />