summaryrefslogtreecommitdiff
path: root/doc/classes/CanvasLayer.xml
blob: c3f2e438920f7b89f38b5844c8ee49c1bacacf02 (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
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
<?xml version="1.0" encoding="UTF-8" ?>
<class name="CanvasLayer" inherits="Node" category="Core" version="3.0.alpha.custom_build">
	<brief_description>
		Canvas drawing layer.
	</brief_description>
	<description>
		Canvas drawing layer. [CanvasItem] nodes that are direct or indirect children of a [code]CanvasLayer[/code] will be drawn in that layer. The layer is a numeric index that defines the draw order. The default 2D scene renders with index 0, so a [code]CanvasLayer[/code] with index -1 will be drawn below, and one with index 1 will be drawn above. This is very useful for HUDs (in layer 1+ or above), or backgrounds (in layer -1 or below).
	</description>
	<tutorials>
	</tutorials>
	<demos>
	</demos>
	<methods>
		<method name="get_custom_viewport" qualifiers="const">
			<return type="Node">
			</return>
			<description>
			</description>
		</method>
		<method name="get_layer" qualifiers="const">
			<return type="int">
			</return>
			<description>
				Return the layer index, determines the draw order, a lower value will be below a higher one.
			</description>
		</method>
		<method name="get_offset" qualifiers="const">
			<return type="Vector2">
			</return>
			<description>
				Return the base offset for this layer (helper).
			</description>
		</method>
		<method name="get_rotation" qualifiers="const">
			<return type="float">
			</return>
			<description>
				Return the base rotation for this layer in radians (helper).
			</description>
		</method>
		<method name="get_rotationd" qualifiers="const">
			<return type="float">
			</return>
			<description>
				Return the base rotation for this layer in degrees.
			</description>
		</method>
		<method name="get_scale" qualifiers="const">
			<return type="Vector2">
			</return>
			<description>
				Return the base scale for this layer (helper).
			</description>
		</method>
		<method name="get_transform" qualifiers="const">
			<return type="Transform2D">
			</return>
			<description>
				Return the base transform for this layer.
			</description>
		</method>
		<method name="get_world_2d" qualifiers="const">
			<return type="World2D">
			</return>
			<description>
				Return the [World2D] used by this layer.
			</description>
		</method>
		<method name="set_custom_viewport">
			<return type="void">
			</return>
			<argument index="0" name="viewport" type="Node">
			</argument>
			<description>
			</description>
		</method>
		<method name="set_layer">
			<return type="void">
			</return>
			<argument index="0" name="layer" type="int">
			</argument>
			<description>
				Set the layer index, determines the draw order, a lower value will be below a higher one.
			</description>
		</method>
		<method name="set_offset">
			<return type="void">
			</return>
			<argument index="0" name="offset" type="Vector2">
			</argument>
			<description>
				Set the base offset for this layer (helper).
			</description>
		</method>
		<method name="set_rotation">
			<return type="void">
			</return>
			<argument index="0" name="radians" type="float">
			</argument>
			<description>
				Set the base rotation for this layer in radians (helper).
			</description>
		</method>
		<method name="set_rotationd">
			<return type="void">
			</return>
			<argument index="0" name="degrees" type="float">
			</argument>
			<description>
				Set the base rotation for this layer in degrees (helper).
			</description>
		</method>
		<method name="set_scale">
			<return type="void">
			</return>
			<argument index="0" name="scale" type="Vector2">
			</argument>
			<description>
				Set the base scale for this layer (helper).
			</description>
		</method>
		<method name="set_transform">
			<return type="void">
			</return>
			<argument index="0" name="transform" type="Transform2D">
			</argument>
			<description>
				Set the base transform for this layer.
			</description>
		</method>
	</methods>
	<members>
		<member name="layer" type="int" setter="set_layer" getter="get_layer">
			Layer index for draw order. Lower values are drawn first. Default value: [code]1[/code].
		</member>
		<member name="offset" type="Vector2" setter="set_offset" getter="get_offset">
			The layer's base offset.
		</member>
		<member name="rotation" type="float" setter="set_rotationd" getter="get_rotationd">
			The layer's rotation in degrees.
		</member>
		<member name="scale" type="Vector2" setter="set_scale" getter="get_scale">
			The layer's scale.
		</member>
	</members>
	<constants>
	</constants>
</class>