7adf4cc9b5
For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
81 lines
3.1 KiB
XML
81 lines
3.1 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
||
<class name="Texture2D" inherits="Texture" version="4.0">
|
||
<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 [Sprite2D] or GUI [Control].
|
||
Textures are often created by loading them from a file. See [method @GDScript.load].
|
||
[Texture2D] is a base for other resources. It cannot be used directly.
|
||
[b]Note:[/b] The maximum texture size is 16384×16384 pixels due to graphics hardware limitations. Larger textures may fail to import.
|
||
</description>
|
||
<tutorials>
|
||
</tutorials>
|
||
<methods>
|
||
<method name="draw" qualifiers="const">
|
||
<return type="void" />
|
||
<argument index="0" name="canvas_item" type="RID" />
|
||
<argument index="1" name="position" type="Vector2" />
|
||
<argument index="2" name="modulate" type="Color" default="Color(1, 1, 1, 1)" />
|
||
<argument index="3" name="transpose" type="bool" default="false" />
|
||
<description>
|
||
Draws the texture using a [CanvasItem] with the [RenderingServer] API at the specified [code]position[/code].
|
||
</description>
|
||
</method>
|
||
<method name="draw_rect" qualifiers="const">
|
||
<return type="void" />
|
||
<argument index="0" name="canvas_item" type="RID" />
|
||
<argument index="1" name="rect" type="Rect2" />
|
||
<argument index="2" name="tile" type="bool" />
|
||
<argument index="3" name="modulate" type="Color" default="Color(1, 1, 1, 1)" />
|
||
<argument index="4" name="transpose" type="bool" default="false" />
|
||
<description>
|
||
Draws the texture using a [CanvasItem] with the [RenderingServer] API.
|
||
</description>
|
||
</method>
|
||
<method name="draw_rect_region" qualifiers="const">
|
||
<return type="void" />
|
||
<argument index="0" name="canvas_item" type="RID" />
|
||
<argument index="1" name="rect" type="Rect2" />
|
||
<argument index="2" name="src_rect" type="Rect2" />
|
||
<argument index="3" name="modulate" type="Color" default="Color(1, 1, 1, 1)" />
|
||
<argument index="4" name="transpose" type="bool" default="false" />
|
||
<argument index="5" name="clip_uv" type="bool" default="true" />
|
||
<description>
|
||
Draws a part of the texture using a [CanvasItem] with the [RenderingServer] API.
|
||
</description>
|
||
</method>
|
||
<method name="get_height" qualifiers="const">
|
||
<return type="int" />
|
||
<description>
|
||
Returns the texture height.
|
||
</description>
|
||
</method>
|
||
<method name="get_image" qualifiers="const">
|
||
<return type="Image" />
|
||
<description>
|
||
Returns an [Image] that is a copy of data from this [Texture2D]. [Image]s can be accessed and manipulated directly.
|
||
</description>
|
||
</method>
|
||
<method name="get_size" qualifiers="const">
|
||
<return type="Vector2" />
|
||
<description>
|
||
Returns the texture size.
|
||
</description>
|
||
</method>
|
||
<method name="get_width" qualifiers="const">
|
||
<return type="int" />
|
||
<description>
|
||
Returns the texture width.
|
||
</description>
|
||
</method>
|
||
<method name="has_alpha" qualifiers="const">
|
||
<return type="bool" />
|
||
<description>
|
||
Returns [code]true[/code] if this [Texture2D] has an alpha channel.
|
||
</description>
|
||
</method>
|
||
</methods>
|
||
<constants>
|
||
</constants>
|
||
</class>
|