mirror of
https://github.com/godotengine/godot-docs.git
synced 2026-01-04 14:11:02 +03:00
57 lines
2.4 KiB
ReStructuredText
57 lines
2.4 KiB
ReStructuredText
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
|
|
.. DO NOT EDIT THIS FILE, but the ShaderMaterial.xml source instead.
|
|
.. The source is found in doc/classes or modules/<name>/doc_classes.
|
|
|
|
.. _class_ShaderMaterial:
|
|
|
|
ShaderMaterial
|
|
==============
|
|
|
|
**Inherits:** :ref:`Material<class_material>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
|
|
|
|
**Category:** Core
|
|
|
|
Brief Description
|
|
-----------------
|
|
|
|
A material that uses a custom :ref:`Shader<class_shader>` program.
|
|
|
|
Member Functions
|
|
----------------
|
|
|
|
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Variant<class_variant>` | :ref:`get_shader_param<class_ShaderMaterial_get_shader_param>` **(** :ref:`String<class_string>` param **)** const |
|
|
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`set_shader_param<class_ShaderMaterial_set_shader_param>` **(** :ref:`String<class_string>` param, :ref:`Variant<class_variant>` value **)** |
|
|
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
|
Member Variables
|
|
----------------
|
|
|
|
.. _class_ShaderMaterial_shader:
|
|
|
|
- :ref:`Shader<class_shader>` **shader** - The :ref:`Shader<class_shader>` program used to render this material.
|
|
|
|
|
|
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.
|
|
|
|
Member Function Description
|
|
---------------------------
|
|
|
|
.. _class_ShaderMaterial_get_shader_param:
|
|
|
|
- :ref:`Variant<class_variant>` **get_shader_param** **(** :ref:`String<class_string>` param **)** const
|
|
|
|
Returns the current value set for this material of a uniform in the shader.
|
|
|
|
.. _class_ShaderMaterial_set_shader_param:
|
|
|
|
- void **set_shader_param** **(** :ref:`String<class_string>` param, :ref:`Variant<class_variant>` value **)**
|
|
|
|
Changes the value set for this material of a uniform in the shader.
|
|
|
|
|