diff options
Diffstat (limited to 'doc/classes/Texture.xml')
| -rw-r--r-- | doc/classes/Texture.xml | 141 |
1 files changed, 141 insertions, 0 deletions
diff --git a/doc/classes/Texture.xml b/doc/classes/Texture.xml new file mode 100644 index 0000000000..d09236bbc9 --- /dev/null +++ b/doc/classes/Texture.xml @@ -0,0 +1,141 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="Texture" inherits="Resource" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Texture for 2D and 3D. + </brief_description> + <description> + A texture works by registering an image in the video hardware, which then can be used in 3D models or 2D [Sprite] or GUI [Control]. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="draw" qualifiers="const"> + <return type="void"> + </return> + <argument index="0" name="canvas_item" type="RID"> + </argument> + <argument index="1" name="pos" type="Vector2"> + </argument> + <argument index="2" name="modulate" type="Color" default="Color( 1, 1, 1, 1 )"> + </argument> + <argument index="3" name="transpose" type="bool" default="false"> + </argument> + <argument index="4" name="normal_map" type="Texture" default="null"> + </argument> + <description> + </description> + </method> + <method name="draw_rect" qualifiers="const"> + <return type="void"> + </return> + <argument index="0" name="canvas_item" type="RID"> + </argument> + <argument index="1" name="rect" type="Rect2"> + </argument> + <argument index="2" name="tile" type="bool"> + </argument> + <argument index="3" name="modulate" type="Color" default="Color( 1, 1, 1, 1 )"> + </argument> + <argument index="4" name="transpose" type="bool" default="false"> + </argument> + <argument index="5" name="normal_map" type="Texture" default="null"> + </argument> + <description> + </description> + </method> + <method name="draw_rect_region" qualifiers="const"> + <return type="void"> + </return> + <argument index="0" name="canvas_item" type="RID"> + </argument> + <argument index="1" name="rect" type="Rect2"> + </argument> + <argument index="2" name="src_rect" type="Rect2"> + </argument> + <argument index="3" name="modulate" type="Color" default="Color( 1, 1, 1, 1 )"> + </argument> + <argument index="4" name="transpose" type="bool" default="false"> + </argument> + <argument index="5" name="normal_map" type="Texture" default="null"> + </argument> + <argument index="6" name="clip_uv" type="bool" default="true"> + </argument> + <description> + </description> + </method> + <method name="get_data" qualifiers="const"> + <return type="Image"> + </return> + <description> + </description> + </method> + <method name="get_flags" qualifiers="const"> + <return type="int"> + </return> + <description> + Return the current texture flags. + </description> + </method> + <method name="get_height" qualifiers="const"> + <return type="int"> + </return> + <description> + Return the texture height. + </description> + </method> + <method name="get_size" qualifiers="const"> + <return type="Vector2"> + </return> + <description> + Return the texture size. + </description> + </method> + <method name="get_width" qualifiers="const"> + <return type="int"> + </return> + <description> + Return the texture width. + </description> + </method> + <method name="has_alpha" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="set_flags"> + <return type="void"> + </return> + <argument index="0" name="flags" type="int"> + </argument> + <description> + Change the texture flags. + </description> + </method> + </methods> + <constants> + <constant name="FLAG_MIPMAPS" value="1"> + Generate mipmaps, to enable smooth zooming out of the texture. + </constant> + <constant name="FLAG_REPEAT" value="2"> + Repeat (instead of clamp to edge). + </constant> + <constant name="FLAG_FILTER" value="4"> + Turn on magnifying filter, to enable smooth zooming in of the texture. + </constant> + <constant name="FLAG_VIDEO_SURFACE" value="4096"> + Texture is a video surface. + </constant> + <constant name="FLAGS_DEFAULT" value="7"> + Default flags. Generate mipmaps, repeat, and filter are enabled. + </constant> + <constant name="FLAG_ANISOTROPIC_FILTER" value="8"> + </constant> + <constant name="FLAG_CONVERT_TO_LINEAR" value="16"> + </constant> + <constant name="FLAG_MIRRORED_REPEAT" value="32"> + </constant> + </constants> +</class> |