mirror of
https://github.com/godotengine/godot.git
synced 2024-10-23 13:41:43 +00:00
81064cc239
We don't use that info for anything, and it generates unnecessary diffs every time we bump the minor version (and CI failures if we forget to sync some files from opt-in modules (mono, text_server_fb).
37 lines
2.0 KiB
XML
37 lines
2.0 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
|
<class name="ShaderMaterial" inherits="Material" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
|
|
<brief_description>
|
|
A material that uses a custom [Shader] program.
|
|
</brief_description>
|
|
<description>
|
|
A material that uses a custom [Shader] program to render either items to screen or process particles. You can create multiple materials for the same shader but configure different values for the uniforms defined in the shader.
|
|
</description>
|
|
<tutorials>
|
|
<link title="Shaders documentation index">$DOCS_URL/tutorials/shaders/index.html</link>
|
|
</tutorials>
|
|
<methods>
|
|
<method name="get_shader_parameter" qualifiers="const">
|
|
<return type="Variant" />
|
|
<param index="0" name="param" type="StringName" />
|
|
<description>
|
|
Returns the current value set for this material of a uniform in the shader.
|
|
</description>
|
|
</method>
|
|
<method name="set_shader_parameter">
|
|
<return type="void" />
|
|
<param index="0" name="param" type="StringName" />
|
|
<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] 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>
|
|
<members>
|
|
<member name="shader" type="Shader" setter="set_shader" getter="get_shader">
|
|
The [Shader] program used to render this material.
|
|
</member>
|
|
</members>
|
|
</class>
|