hertog/godot-module-template
Template
2
1
Fork 1
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Clarify the difference between uniforms and per-instance uniforms in docs

Browse source
This commit is contained in:
Hugo Locurcio 2023-01-11 20:08:33 +01:00
parent f73cb4c13d
commit 2841047657
No known key found for this signature in database
GPG key ID: 39E8F8BE30B0A49C
2 changed files with 6 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

3
doc/classes/ShaderMaterial.xml
View file

@ -23,7 +23,8 @@
<param index="1" name="value" type="Variant" />
<description>
Changes the value set for this material of a uniform in the shader.
[b]Note:[/b] [param param] must match the name of the uniform in the code exactly.
[b]Note:[/b] [param param] is case-sensitive and must match the name of the uniform in the code exactly (not the capitalized name in the inspector).
[b]Note:[/b] Changes to the shader uniform will be effective on all instances using this [ShaderMaterial]. To prevent this, use per-instance uniforms with [method GeometryInstance3D.set_instance_shader_parameter] or duplicate the [ShaderMaterial] resource using [method Resource.duplicate]. Per-instance uniforms allow for better shader reuse and are therefore faster, so they should be preferred over duplicating the [ShaderMaterial] when possible.
</description>
</method>
</methods>