virtualx-engine/doc/classes/Texture.xml

135 lines
4.4 KiB
XML
Raw Normal View History

<?xml version="1.0" encoding="UTF-8" ?>
<class name="Texture" inherits="Resource" category="Core" version="3.1">
<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="position" 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_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>
</methods>
2018-01-11 23:38:35 +01:00
<members>
<member name="flags" type="int" setter="set_flags" getter="get_flags">
The texture's flags.
</member>
</members>
<constants>
2018-01-11 23:38:35 +01:00
<constant name="FLAGS_DEFAULT" value="7" enum="Flags">
Default flags. Generate mipmaps, repeat, and filter are enabled.
</constant>
2017-11-24 23:16:30 +01:00
<constant name="FLAG_MIPMAPS" value="1" enum="Flags">
2017-11-26 16:37:37 +01:00
Generate mipmaps, which are smaller versions of the same texture to use when zoomed out, keeping the aspect ratio.
</constant>
2017-11-24 23:16:30 +01:00
<constant name="FLAG_REPEAT" value="2" enum="Flags">
2017-11-26 16:37:37 +01:00
Repeats texture (instead of clamp to edge).
</constant>
2017-11-24 23:16:30 +01:00
<constant name="FLAG_FILTER" value="4" enum="Flags">
2017-11-26 16:37:37 +01:00
Magnifying filter, to enable smooth zooming in of the texture.
</constant>
2017-11-24 23:16:30 +01:00
<constant name="FLAG_ANISOTROPIC_FILTER" value="8" enum="Flags">
2017-11-26 16:37:37 +01:00
Anisotropic mipmap filtering. Generates smaller versions of the same texture with different aspect ratios.
More effective on planes often shown going to the horrizon as those textures (Walls or Ground for example) get squashed in the viewport to different aspect ratios and regular mipmaps keep the aspect ratio so they don't optimize storage that well in those cases.
</constant>
2017-11-24 23:16:30 +01:00
<constant name="FLAG_CONVERT_TO_LINEAR" value="16" enum="Flags">
2017-12-10 00:43:30 +01:00
Converts texture to SRGB color space.
</constant>
2017-11-24 23:16:30 +01:00
<constant name="FLAG_MIRRORED_REPEAT" value="32" enum="Flags">
2017-11-26 16:37:37 +01:00
Repeats texture with alternate sections mirrored.
</constant>
2017-11-24 23:16:30 +01:00
<constant name="FLAG_VIDEO_SURFACE" value="4096" enum="Flags">
Texture is a video surface.
</constant>
</constants>
</class>