mirror of
https://github.com/Relintai/pandemonium_engine.git
synced 2024-12-27 06:07:14 +01:00
53 lines
2.1 KiB
XML
53 lines
2.1 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
|
<class name="ShaderMaterial" inherits="Material" version="4.4">
|
|
<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.
|
|
[b]Note:[/b] Due to a renderer limitation, emissive [ShaderMaterial]s cannot emit light when used in a [GIProbe]. Only emissive [SpatialMaterial]s can emit light in a [GIProbe].
|
|
</description>
|
|
<tutorials>
|
|
<link>$DOCS_URL/tutorials/shaders/index.md</link>
|
|
</tutorials>
|
|
<methods>
|
|
<method name="get_shader_param" qualifiers="const">
|
|
<return type="Variant" />
|
|
<argument 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="property_can_revert">
|
|
<return type="bool" />
|
|
<argument index="0" name="name" type="String" />
|
|
<description>
|
|
Returns [code]true[/code] if the property identified by [code]name[/code] can be reverted to a default value.
|
|
</description>
|
|
</method>
|
|
<method name="property_get_revert">
|
|
<return type="Variant" />
|
|
<argument index="0" name="name" type="String" />
|
|
<description>
|
|
Returns the default value of the material property with given [code]name[/code].
|
|
</description>
|
|
</method>
|
|
<method name="set_shader_param">
|
|
<return type="void" />
|
|
<argument index="0" name="param" type="StringName" />
|
|
<argument index="1" name="value" type="Variant" />
|
|
<description>
|
|
Changes the value set for this material of a uniform in the shader.
|
|
[b]Note:[/b] [code]param[/code] must match the name of the uniform in the code exactly.
|
|
</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>
|
|
<constants>
|
|
</constants>
|
|
</class>
|