diff options
Diffstat (limited to 'doc/classes/TextureRect.xml')
-rw-r--r-- | doc/classes/TextureRect.xml | 94 |
1 files changed, 94 insertions, 0 deletions
diff --git a/doc/classes/TextureRect.xml b/doc/classes/TextureRect.xml new file mode 100644 index 0000000000..af5626ae84 --- /dev/null +++ b/doc/classes/TextureRect.xml @@ -0,0 +1,94 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="TextureRect" inherits="Control" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Draws a sprite or a texture inside a User Interface. The texture can tile or not. + </brief_description> + <description> + Use TextureRect to draw icons and sprites in your User Interfaces. To create panels and menu boxes, take a look at [NinePatchFrame]. Its Stretch Mode property controls the texture's scale and placement. It can scale, tile and stay centered inside its bounding rectangle. TextureRect is one of the 5 most common nodes to create game UI. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_stretch_mode" qualifiers="const"> + <return type="int" enum="TextureRect.StretchMode"> + </return> + <description> + </description> + </method> + <method name="get_texture" qualifiers="const"> + <return type="Texture"> + </return> + <description> + </description> + </method> + <method name="has_expand" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="set_expand"> + <return type="void"> + </return> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_stretch_mode"> + <return type="void"> + </return> + <argument index="0" name="stretch_mode" type="int" enum="TextureRect.StretchMode"> + </argument> + <description> + </description> + </method> + <method name="set_texture"> + <return type="void"> + </return> + <argument index="0" name="texture" type="Texture"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="expand" type="bool" setter="set_expand" getter="has_expand"> + If [code]true[/code], the texture scales to fit its bounding rectangle. Default value: [code]false[/code]. + </member> + <member name="stretch_mode" type="int" setter="set_stretch_mode" getter="get_stretch_mode" enum="TextureRect.StretchMode"> + Controls the texture's behavior when you resize the node's bounding rectangle. Set it to one of the [code]STRETCH_*[/code] constants. See the constants to learn more. + </member> + <member name="texture" type="Texture" setter="set_texture" getter="get_texture"> + The node's [Texture] resource. + </member> + </members> + <constants> + <constant name="STRETCH_SCALE_ON_EXPAND" value="0"> + Scale to fit the node's bounding rectangle, only if [code]expand[/code] is [code]true[/code]. Default [code]stretch_mode[/code], for backwards compatibility. Until you set [code]expand[/code] to [code]true[/code], the texture will behave like [code]STRETCH_KEEP[/code]. + </constant> + <constant name="STRETCH_SCALE" value="1"> + Scale to fit the node's bounding rectangle. + </constant> + <constant name="STRETCH_TILE" value="2"> + Tile inside the node's bounding rectangle. + </constant> + <constant name="STRETCH_KEEP" value="3"> + The texture keeps its original size and stays in the bounding rectangle's top-left corner. + </constant> + <constant name="STRETCH_KEEP_CENTERED" value="4"> + The texture keeps its original size and stays centered in the node's bounding rectangle. + </constant> + <constant name="STRETCH_KEEP_ASPECT" value="5"> + Scale the texture to fit the node's bounding rectangle, but maintain the texture's aspect ratio. + </constant> + <constant name="STRETCH_KEEP_ASPECT_CENTERED" value="6"> + Scale the texture to fit the node's bounding rectangle, center it and maintain its aspect ratio. + </constant> + <constant name="STRETCH_KEEP_ASPECT_COVERED" value="7"> + Scale the texture so that the shorter side fits the bounding rectangle. The other side clips to the node's limits. + </constant> + </constants> +</class> |