summaryrefslogtreecommitdiff
path: root/doc/classes/StyleBoxTexture.xml
blob: 806ed1941a4455e944bd745e84a859316de27c1a (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
<?xml version="1.0" encoding="UTF-8" ?>
<class name="StyleBoxTexture" inherits="StyleBox" category="Core" version="3.1">
	<brief_description>
		Texture Based 3x3 scale style.
	</brief_description>
	<description>
		Texture Based 3x3 scale style. This stylebox performs a 3x3 scaling of a texture, where only the center cell is fully stretched. This allows for the easy creation of bordered styles.
	</description>
	<tutorials>
	</tutorials>
	<demos>
	</demos>
	<methods>
		<method name="set_expand_margin_all">
			<return type="void">
			</return>
			<argument index="0" name="size" type="float">
			</argument>
			<description>
			</description>
		</method>
		<method name="set_expand_margin_individual">
			<return type="void">
			</return>
			<argument index="0" name="size_left" type="float">
			</argument>
			<argument index="1" name="size_top" type="float">
			</argument>
			<argument index="2" name="size_right" type="float">
			</argument>
			<argument index="3" name="size_bottom" type="float">
			</argument>
			<description>
			</description>
		</method>
	</methods>
	<members>
		<member name="axis_stretch_horizontal" type="int" setter="set_h_axis_stretch_mode" getter="get_h_axis_stretch_mode" enum="StyleBoxTexture.AxisStretchMode">
		</member>
		<member name="axis_stretch_vertical" type="int" setter="set_v_axis_stretch_mode" getter="get_v_axis_stretch_mode" enum="StyleBoxTexture.AxisStretchMode">
		</member>
		<member name="draw_center" type="bool" setter="set_draw_center" getter="is_draw_center_enabled">
		</member>
		<member name="expand_margin_bottom" type="float" setter="set_expand_margin_size" getter="get_expand_margin_size">
			Expands the bottom margin of this style box when drawing, causing it be drawn larger than requested.
		</member>
		<member name="expand_margin_left" type="float" setter="set_expand_margin_size" getter="get_expand_margin_size">
			Expands the left margin of this style box when drawing, causing it be drawn larger than requested.
		</member>
		<member name="expand_margin_right" type="float" setter="set_expand_margin_size" getter="get_expand_margin_size">
			Expands the right margin of this style box when drawing, causing it be drawn larger than requested.
		</member>
		<member name="expand_margin_top" type="float" setter="set_expand_margin_size" getter="get_expand_margin_size">
			Expands the top margin of this style box when drawing, causing it be drawn larger than requested.
		</member>
		<member name="margin_bottom" type="float" setter="set_margin_size" getter="get_margin_size">
			Increases the bottom margin of the 3x3 texture box.
			A higher value means more of the source texture is considered to be part of the bottom border of the 3x3 box.
			This is also the value used as fallback for [member StyleBox.content_margin_bottom] if it is negative.
		</member>
		<member name="margin_left" type="float" setter="set_margin_size" getter="get_margin_size">
			Increases the left margin of the 3x3 texture box.
			A higher value means more of the source texture is considered to be part of the left border of the 3x3 box.
			This is also the value used as fallback for [member StyleBox.content_margin_left] if it is negative.
		</member>
		<member name="margin_right" type="float" setter="set_margin_size" getter="get_margin_size">
			Increases the right margin of the 3x3 texture box.
			A higher value means more of the source texture is considered to be part of the right border of the 3x3 box.
			This is also the value used as fallback for [member StyleBox.content_margin_right] if it is negative.
		</member>
		<member name="margin_top" type="float" setter="set_margin_size" getter="get_margin_size">
			Increases the top margin of the 3x3 texture box.
			A higher value means more of the source texture is considered to be part of the top border of the 3x3 box.
			This is also the value used as fallback for [member StyleBox.content_margin_top] if it is negative.
		</member>
		<member name="modulate_color" type="Color" setter="set_modulate" getter="get_modulate">
			Modulates the color of the texture when this style box is drawn.
		</member>
		<member name="normal_map" type="Texture" setter="set_normal_map" getter="get_normal_map">
			The normal map to use when drawing this style box.
		</member>
		<member name="region_rect" type="Rect2" setter="set_region_rect" getter="get_region_rect">
			Species a sub region of the texture to use.
			This is equivalent to first wrapping the texture in an [AtlasTexture] with the same region.
		</member>
		<member name="texture" type="Texture" setter="set_texture" getter="get_texture">
			The texture to use when drawing this style box.
		</member>
	</members>
	<signals>
		<signal name="texture_changed">
			<description>
			</description>
		</signal>
	</signals>
	<constants>
		<constant name="AXIS_STRETCH_MODE_STRETCH" value="0" enum="AxisStretchMode">
		</constant>
		<constant name="AXIS_STRETCH_MODE_TILE" value="1" enum="AxisStretchMode">
		</constant>
		<constant name="AXIS_STRETCH_MODE_TILE_FIT" value="2" enum="AxisStretchMode">
		</constant>
	</constants>
</class>