summaryrefslogtreecommitdiff
path: root/doc/classes/ImmediateMesh.xml
blob: d2ae091cad2673aa1798cf8ed3e6dcedc239248d (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
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
<?xml version="1.0" encoding="UTF-8" ?>
<class name="ImmediateMesh" inherits="Mesh" version="4.0">
	<brief_description>
		Mesh optimized for creating geometry manually.
	</brief_description>
	<description>
		Mesh optimized for creating geometry manually, similar to OpenGL1.x immediate mode.
	</description>
	<tutorials>
	</tutorials>
	<methods>
		<method name="clear_surfaces">
			<return type="void">
			</return>
			<description>
				Clear all surfaces.
			</description>
		</method>
		<method name="surface_add_vertex">
			<return type="void">
			</return>
			<argument index="0" name="vertex" type="Vector3">
			</argument>
			<description>
				Add a 3D vertex using the current attributes previously set.
			</description>
		</method>
		<method name="surface_add_vertex_2d">
			<return type="void">
			</return>
			<argument index="0" name="vertex" type="Vector2">
			</argument>
			<description>
				Add a 2D vertex using the current attributes previously set.
			</description>
		</method>
		<method name="surface_begin">
			<return type="void">
			</return>
			<argument index="0" name="primitive" type="int" enum="Mesh.PrimitiveType">
			</argument>
			<argument index="1" name="material" type="Material" default="null">
			</argument>
			<description>
				Begin a new surface.
			</description>
		</method>
		<method name="surface_end">
			<return type="void">
			</return>
			<description>
				End and commit current surface. Note that surface being created will not be visible until this function is called.
			</description>
		</method>
		<method name="surface_set_color">
			<return type="void">
			</return>
			<argument index="0" name="color" type="Color">
			</argument>
			<description>
				Set the color attribute that will be pushed with the next vertex.
			</description>
		</method>
		<method name="surface_set_normal">
			<return type="void">
			</return>
			<argument index="0" name="normal" type="Vector3">
			</argument>
			<description>
				Set the normal attribute that will be pushed with the next vertex.
			</description>
		</method>
		<method name="surface_set_tangent">
			<return type="void">
			</return>
			<argument index="0" name="tangent" type="Plane">
			</argument>
			<description>
				Set the tangent attribute that will be pushed with the next vertex.
			</description>
		</method>
		<method name="surface_set_uv">
			<return type="void">
			</return>
			<argument index="0" name="uv" type="Vector2">
			</argument>
			<description>
				Set the UV attribute that will be pushed with the next vertex.
			</description>
		</method>
		<method name="surface_set_uv2">
			<return type="void">
			</return>
			<argument index="0" name="uv2" type="Vector2">
			</argument>
			<description>
				Set the UV2 attribute that will be pushed with the next vertex.
			</description>
		</method>
	</methods>
	<constants>
	</constants>
</class>