summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorYuri Roubinsky <chaosus89@gmail.com>2021-10-17 14:38:26 +0300
committerYuri Roubinsky <chaosus89@gmail.com>2021-11-12 12:53:40 +0300
commit826e781bfa90f55eed579e9b512a19b0c1c19ba4 (patch)
tree5c6f1a88cfed28ab09ff3e959e1c724dcdbebae1 /doc
parent13769aebe9d435b9041f4ec8dc6f4b277a87b444 (diff)
Fix default_texture_param in shader pipeline to support uniform arrays
Diffstat (limited to 'doc')
-rw-r--r--doc/classes/RenderingServer.xml4
-rw-r--r--doc/classes/Shader.xml4
2 files changed, 8 insertions, 0 deletions
diff --git a/doc/classes/RenderingServer.xml b/doc/classes/RenderingServer.xml
index 68b79ff749..ddb25788c8 100644
--- a/doc/classes/RenderingServer.xml
+++ b/doc/classes/RenderingServer.xml
@@ -2661,8 +2661,10 @@
<return type="RID" />
<argument index="0" name="shader" type="RID" />
<argument index="1" name="param" type="StringName" />
+ <argument index="2" name="index" type="int" default="0" />
<description>
Returns a default texture from a shader searched by name.
+ [b]Note:[/b] If the sampler array is used use [code]index[/code] to access the specified texture.
</description>
</method>
<method name="shader_get_param_default" qualifiers="const">
@@ -2684,8 +2686,10 @@
<argument index="0" name="shader" type="RID" />
<argument index="1" name="param" type="StringName" />
<argument index="2" name="texture" type="RID" />
+ <argument index="3" name="index" type="int" default="0" />
<description>
Sets a shader's default texture. Overwrites the texture given by name.
+ [b]Note:[/b] If the sampler array is used use [code]index[/code] to access the specified texture.
</description>
</method>
<method name="shadows_quality_set">
diff --git a/doc/classes/Shader.xml b/doc/classes/Shader.xml
index 99e38e969d..751afb9b65 100644
--- a/doc/classes/Shader.xml
+++ b/doc/classes/Shader.xml
@@ -13,9 +13,11 @@
<method name="get_default_texture_param" qualifiers="const">
<return type="Texture2D" />
<argument index="0" name="param" type="StringName" />
+ <argument index="1" name="index" type="int" default="0" />
<description>
Returns the texture that is set as default for the specified parameter.
[b]Note:[/b] [code]param[/code] must match the name of the uniform in the code exactly.
+ [b]Note:[/b] If the sampler array is used use [code]index[/code] to access the specified texture.
</description>
</method>
<method name="get_mode" qualifiers="const">
@@ -36,9 +38,11 @@
<return type="void" />
<argument index="0" name="param" type="StringName" />
<argument index="1" name="texture" type="Texture2D" />
+ <argument index="2" name="index" type="int" default="0" />
<description>
Sets the default texture to be used with a texture uniform. The default is used if a texture is not set in the [ShaderMaterial].
[b]Note:[/b] [code]param[/code] must match the name of the uniform in the code exactly.
+ [b]Note:[/b] If the sampler array is used use [code]index[/code] to access the specified texture.
</description>
</method>
</methods>