godot/doc/classes/Shader.xml
2018-05-26 12:08:34 +10:00

62 lines
1.7 KiB
XML

<?xml version="1.0" encoding="UTF-8" ?>
<class name="Shader" inherits="Resource" category="Core" version="3.1">
<brief_description>
A custom shader program.
</brief_description>
<description>
This class allows you to define a custom shader program that can be used for various materials to render objects.
</description>
<tutorials>
http://docs.godotengine.org/en/3.0/tutorials/shading/index.html
</tutorials>
<demos>
</demos>
<methods>
<method name="get_default_texture_param" qualifiers="const">
<return type="Texture">
</return>
<argument index="0" name="param" type="String">
</argument>
<description>
</description>
</method>
<method name="get_mode" qualifiers="const">
<return type="int" enum="Shader.Mode">
</return>
<description>
Returns the shader mode for the shader, eiter [code]MODE_CANVAS_ITEM[/code], [code]MODE_SPATIAL[/code] or [code]MODE_PARTICLES[/code]
</description>
</method>
<method name="has_param" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="name" type="String">
</argument>
<description>
</description>
</method>
<method name="set_default_texture_param">
<return type="void">
</return>
<argument index="0" name="param" type="String">
</argument>
<argument index="1" name="texture" type="Texture">
</argument>
<description>
</description>
</method>
</methods>
<members>
<member name="code" type="String" setter="set_code" getter="get_code">
</member>
</members>
<constants>
<constant name="MODE_SPATIAL" value="0" enum="Mode">
</constant>
<constant name="MODE_CANVAS_ITEM" value="1" enum="Mode">
</constant>
<constant name="MODE_PARTICLES" value="2" enum="Mode">
</constant>
</constants>
</class>