2022-03-15 13:29:32 +01:00
<?xml version="1.0" encoding="UTF-8" ?>
2024-09-20 10:03:06 +02:00
<class name= "StyleBoxTexture" inherits= "StyleBox" >
2022-03-15 13:29:32 +01:00
<brief_description >
Texture-based nine-patch [StyleBox].
</brief_description>
<description >
Texture-based nine-patch [StyleBox], in a way similar to [NinePatchRect]. This stylebox performs a 3×
</description>
<tutorials >
</tutorials>
<methods >
<method name= "get_expand_margin_size" qualifiers= "const" >
<return type= "float" />
<argument index= "0" name= "margin" type= "int" enum= "Margin" />
<description >
Returns the size of the given [code]margin[/code]'s expand margin. See [enum Margin] for possible values.
</description>
</method>
<method name= "get_margin_size" qualifiers= "const" >
<return type= "float" />
<argument index= "0" name= "margin" type= "int" enum= "Margin" />
<description >
Returns the size of the given [code]margin[/code]. See [enum Margin] for possible values.
</description>
</method>
<method name= "set_expand_margin_all" >
<return type= "void" />
<argument index= "0" name= "size" type= "float" />
<description >
Sets the expand margin to [code]size[/code] pixels for all margins.
</description>
</method>
<method name= "set_expand_margin_individual" >
<return type= "void" />
<argument index= "0" name= "size_left" type= "float" />
<argument index= "1" name= "size_top" type= "float" />
<argument index= "2" name= "size_right" type= "float" />
<argument index= "3" name= "size_bottom" type= "float" />
<description >
Sets the expand margin for each margin to [code]size_left[/code], [code]size_top[/code], [code]size_right[/code], and [code]size_bottom[/code] pixels.
</description>
</method>
<method name= "set_expand_margin_size" >
<return type= "void" />
<argument index= "0" name= "margin" type= "int" enum= "Margin" />
<argument index= "1" name= "size" type= "float" />
<description >
Sets the expand margin to [code]size[/code] pixels for the given [code]margin[/code]. See [enum Margin] for possible values.
</description>
</method>
<method name= "set_margin_size" >
<return type= "void" />
<argument index= "0" name= "margin" type= "int" enum= "Margin" />
<argument index= "1" name= "size" type= "float" />
<description >
Sets the margin to [code]size[/code] pixels for the given [code]margin[/code]. See [enum Margin] for possible values.
</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" default= "0" >
Controls how the stylebox's texture will be stretched or tiled horizontally. See [enum AxisStretchMode] for possible values.
</member>
<member name= "axis_stretch_vertical" type= "int" setter= "set_v_axis_stretch_mode" getter= "get_v_axis_stretch_mode" enum= "StyleBoxTexture.AxisStretchMode" default= "0" >
Controls how the stylebox's texture will be stretched or tiled vertically. See [enum AxisStretchMode] for possible values.
</member>
<member name= "draw_center" type= "bool" setter= "set_draw_center" getter= "is_draw_center_enabled" default= "true" >
If [code]true[/code], the nine-patch texture's center tile will be drawn.
</member>
<member name= "expand_margin_bottom" type= "float" setter= "set_expand_margin_size" getter= "get_expand_margin_size" default= "0.0" >
Expands the bottom margin of this style box when drawing, causing it to be drawn larger than requested.
</member>
<member name= "expand_margin_left" type= "float" setter= "set_expand_margin_size" getter= "get_expand_margin_size" default= "0.0" >
Expands the left margin of this style box when drawing, causing it to be drawn larger than requested.
</member>
<member name= "expand_margin_right" type= "float" setter= "set_expand_margin_size" getter= "get_expand_margin_size" default= "0.0" >
Expands the right margin of this style box when drawing, causing it to be drawn larger than requested.
</member>
<member name= "expand_margin_top" type= "float" setter= "set_expand_margin_size" getter= "get_expand_margin_size" default= "0.0" >
Expands the top margin of this style box when drawing, causing it to be drawn larger than requested.
</member>
<member name= "margin_bottom" type= "float" setter= "set_margin_size" getter= "get_margin_size" default= "0.0" >
Increases the bottom margin of the 3×
A higher value means more of the source texture is considered to be part of the bottom border of the 3×
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" default= "0.0" >
Increases the left margin of the 3×
A higher value means more of the source texture is considered to be part of the left border of the 3×
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" default= "0.0" >
Increases the right margin of the 3×
A higher value means more of the source texture is considered to be part of the right border of the 3×
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" default= "0.0" >
Increases the top margin of the 3×
A higher value means more of the source texture is considered to be part of the top border of the 3×
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" default= "Color( 1, 1, 1, 1 )" >
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.
[b]Note:[/b] Godot expects the normal map to use X+, Y-, and Z+ coordinates. See [url=http://wiki.polycount.com/wiki/Normal_Map_Technical_Details#Common_Swizzle_Coordinates]this page[/url] for a comparison of normal map coordinates expected by popular engines.
</member>
<member name= "region_rect" type= "Rect2" setter= "set_region_rect" getter= "get_region_rect" default= "Rect2( 0, 0, 0, 0 )" >
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 >
Emitted when the stylebox's texture is changed.
</description>
</signal>
</signals>
<constants >
<constant name= "AXIS_STRETCH_MODE_STRETCH" value= "0" enum= "AxisStretchMode" >
Stretch the stylebox's texture. This results in visible distortion unless the texture size matches the stylebox's size perfectly.
</constant>
<constant name= "AXIS_STRETCH_MODE_TILE" value= "1" enum= "AxisStretchMode" >
Repeats the stylebox's texture to match the stylebox's size according to the nine-patch system.
</constant>
<constant name= "AXIS_STRETCH_MODE_TILE_FIT" value= "2" enum= "AxisStretchMode" >
Repeats the stylebox's texture to match the stylebox's size according to the nine-patch system. Unlike [constant AXIS_STRETCH_MODE_TILE], the texture may be slightly stretched to make the nine-patch texture tile seamlessly.
</constant>
</constants>
</class>
