summaryrefslogtreecommitdiff
path: root/doc/classes/NinePatchRect.xml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/classes/NinePatchRect.xml')
-rw-r--r--doc/classes/NinePatchRect.xml21
1 files changed, 8 insertions, 13 deletions
diff --git a/doc/classes/NinePatchRect.xml b/doc/classes/NinePatchRect.xml
index f4b9d75e91..636ed368d1 100644
--- a/doc/classes/NinePatchRect.xml
+++ b/doc/classes/NinePatchRect.xml
@@ -10,21 +10,16 @@
</tutorials>
<methods>
<method name="get_patch_margin" qualifiers="const">
- <return type="int">
- </return>
- <argument index="0" name="side" type="int" enum="Side">
- </argument>
+ <return type="int" />
+ <argument index="0" name="margin" type="int" enum="Side" />
<description>
Returns the size of the margin on the specified [enum Side].
</description>
</method>
<method name="set_patch_margin">
- <return type="void">
- </return>
- <argument index="0" name="side" type="int" enum="Side">
- </argument>
- <argument index="1" name="value" type="int">
- </argument>
+ <return type="void" />
+ <argument index="0" name="margin" type="int" enum="Side" />
+ <argument index="1" name="value" type="int" />
<description>
Sets the size of the margin on the specified [enum Side] to [code]value[/code] pixels.
</description>
@@ -53,7 +48,7 @@
<member name="patch_margin_top" type="int" setter="set_patch_margin" getter="get_patch_margin" default="0">
The height of the 9-slice's top row. A margin of 16 means the 9-slice's top corners and side will have a height of 16 pixels. You can set all 4 margin values individually to create panels with non-uniform borders.
</member>
- <member name="region_rect" type="Rect2" setter="set_region_rect" getter="get_region_rect" default="Rect2( 0, 0, 0, 0 )">
+ <member name="region_rect" type="Rect2" setter="set_region_rect" getter="get_region_rect" default="Rect2(0, 0, 0, 0)">
Rectangular region of the texture to sample from. If you're working with an atlas, use this property to define the area the 9-slice should use. All other properties are relative to this one. If the rect is empty, NinePatchRect will use the whole texture.
</member>
<member name="texture" type="Texture2D" setter="set_texture" getter="get_texture">
@@ -73,11 +68,11 @@
</constant>
<constant name="AXIS_STRETCH_MODE_TILE" value="1" enum="AxisStretchMode">
Repeats the center texture across the NinePatchRect. This won't cause any visible distortion. The texture must be seamless for this to work without displaying artifacts between edges.
- [b]Note:[/b] Only supported when using the GLES3 renderer. When using the GLES2 renderer, this will behave like [constant AXIS_STRETCH_MODE_STRETCH].
+ [b]Note:[/b] Only supported when using the Vulkan renderer. When using the OpenGL renderer, this will behave like [constant AXIS_STRETCH_MODE_STRETCH].
</constant>
<constant name="AXIS_STRETCH_MODE_TILE_FIT" value="2" enum="AxisStretchMode">
Repeats the center texture across the NinePatchRect, but will also stretch the texture to make sure each tile is visible in full. This may cause the texture to be distorted, but less than [constant AXIS_STRETCH_MODE_STRETCH]. The texture must be seamless for this to work without displaying artifacts between edges.
- [b]Note:[/b] Only supported when using the GLES3 renderer. When using the GLES2 renderer, this will behave like [constant AXIS_STRETCH_MODE_STRETCH].
+ [b]Note:[/b] Only supported when using the Vulkan renderer. When using the OpenGL renderer, this will behave like [constant AXIS_STRETCH_MODE_STRETCH].
</constant>
</constants>
</class>