| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102 |
- :github_url: hide
- .. DO NOT EDIT THIS FILE!!!
- .. Generated automatically from Godot engine sources.
- .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
- .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ShaderMaterial.xml.
- .. _class_ShaderMaterial:
- ShaderMaterial
- ==============
- **Inherits:** :ref:`Material<class_Material>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
- A material that uses a custom :ref:`Shader<class_Shader>` program.
- Description
- -----------
- A material that uses a custom :ref:`Shader<class_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.
- Tutorials
- ---------
- - :doc:`Shaders documentation index <../tutorials/shaders/index>`
- Properties
- ----------
- +-----------------------------+-----------------------------------------------------+
- | :ref:`Shader<class_Shader>` | :ref:`shader<class_ShaderMaterial_property_shader>` |
- +-----------------------------+-----------------------------------------------------+
- Methods
- -------
- +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Variant<class_Variant>` | :ref:`get_shader_param<class_ShaderMaterial_method_get_shader_param>` **(** :ref:`StringName<class_StringName>` param **)** |const| |
- +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`bool<class_bool>` | :ref:`property_can_revert<class_ShaderMaterial_method_property_can_revert>` **(** :ref:`String<class_String>` name **)** |
- +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Variant<class_Variant>` | :ref:`property_get_revert<class_ShaderMaterial_method_property_get_revert>` **(** :ref:`String<class_String>` name **)** |
- +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`set_shader_param<class_ShaderMaterial_method_set_shader_param>` **(** :ref:`StringName<class_StringName>` param, :ref:`Variant<class_Variant>` value **)** |
- +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- Property Descriptions
- ---------------------
- .. _class_ShaderMaterial_property_shader:
- - :ref:`Shader<class_Shader>` **shader**
- +----------+-------------------+
- | *Setter* | set_shader(value) |
- +----------+-------------------+
- | *Getter* | get_shader() |
- +----------+-------------------+
- The :ref:`Shader<class_Shader>` program used to render this material.
- Method Descriptions
- -------------------
- .. _class_ShaderMaterial_method_get_shader_param:
- - :ref:`Variant<class_Variant>` **get_shader_param** **(** :ref:`StringName<class_StringName>` param **)** |const|
- Returns the current value set for this material of a uniform in the shader.
- ----
- .. _class_ShaderMaterial_method_property_can_revert:
- - :ref:`bool<class_bool>` **property_can_revert** **(** :ref:`String<class_String>` name **)**
- Returns ``true`` if the property identified by ``name`` can be reverted to a default value.
- ----
- .. _class_ShaderMaterial_method_property_get_revert:
- - :ref:`Variant<class_Variant>` **property_get_revert** **(** :ref:`String<class_String>` name **)**
- Returns the default value of the material property with given ``name``.
- ----
- .. _class_ShaderMaterial_method_set_shader_param:
- - void **set_shader_param** **(** :ref:`StringName<class_StringName>` param, :ref:`Variant<class_Variant>` value **)**
- Changes the value set for this material of a uniform in the shader.
- \ **Note:** ``param`` must match the name of the uniform in the code exactly.
- .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
- .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
- .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
- .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
- .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
- .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
|
