virtualx-engine/doc/classes/TextureRect.xml

86 lines
2.4 KiB
XML

<?xml version="1.0" encoding="UTF-8" ?>
<class name="TextureRect" inherits="Control" category="Core" version="3.0.alpha.custom_build">
<brief_description>
Control that draws a texture.
</brief_description>
<description>
Control that draws a texture.
</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" brief="">
If [code]true[/code] texture will expand to fit. Default value: [code]false[/code].
</member>
<member name="stretch_mode" type="int" setter="set_stretch_mode" getter="get_stretch_mode" brief="" enum="TextureRect.StretchMode">
Stretch mode of the texture. Use STRETCH_* constants as value.
</member>
<member name="texture" type="Texture" setter="set_texture" getter="get_texture" brief="">
The [Texture] resource for the node.
</member>
</members>
<constants>
<constant name="STRETCH_SCALE_ON_EXPAND" value="0">
</constant>
<constant name="STRETCH_SCALE" value="1">
</constant>
<constant name="STRETCH_TILE" value="2">
</constant>
<constant name="STRETCH_KEEP" value="3">
</constant>
<constant name="STRETCH_KEEP_CENTERED" value="4">
</constant>
<constant name="STRETCH_KEEP_ASPECT" value="5">
</constant>
<constant name="STRETCH_KEEP_ASPECT_CENTERED" value="6">
</constant>
<constant name="STRETCH_KEEP_ASPECT_COVERED" value="7">
</constant>
</constants>
</class>