summaryrefslogtreecommitdiff
path: root/doc/classes/Shader.xml
blob: be9509fda5661b6e03d7e1ef75b69a60ca8ddafc (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
<?xml version="1.0" encoding="UTF-8" ?>
<class name="Shader" inherits="Resource" category="Core" version="3.2">
	<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>
		<link>https://docs.godotengine.org/en/latest/tutorials/shading/index.html</link>
	</tutorials>
	<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, either [constant MODE_CANVAS_ITEM], [constant MODE_SPATIAL] or [constant MODE_PARTICLES]
			</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" default="&quot;&quot;">
		</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>