mirror of
https://github.com/godotengine/godot-docs.git
synced 2026-01-03 05:48:42 +03:00
113 lines
16 KiB
ReStructuredText
113 lines
16 KiB
ReStructuredText
:github_url: hide
|
|
|
|
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
|
|
.. DO NOT EDIT THIS FILE, but the Texture2D.xml source instead.
|
|
.. The source is found in doc/classes or modules/<name>/doc_classes.
|
|
|
|
.. _class_Texture2D:
|
|
|
|
Texture2D
|
|
=========
|
|
|
|
**Inherits:** :ref:`Texture<class_Texture>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
|
|
|
|
**Inherited By:** :ref:`AnimatedTexture<class_AnimatedTexture>`, :ref:`AtlasTexture<class_AtlasTexture>`, :ref:`CameraTexture<class_CameraTexture>`, :ref:`CurveTexture<class_CurveTexture>`, :ref:`GradientTexture<class_GradientTexture>`, :ref:`ImageTexture<class_ImageTexture>`, :ref:`LargeTexture<class_LargeTexture>`, :ref:`MeshTexture<class_MeshTexture>`, :ref:`NoiseTexture<class_NoiseTexture>`, :ref:`ProxyTexture<class_ProxyTexture>`, :ref:`StreamTexture<class_StreamTexture>`, :ref:`ViewportTexture<class_ViewportTexture>`
|
|
|
|
Texture for 2D and 3D.
|
|
|
|
Description
|
|
-----------
|
|
|
|
A texture works by registering an image in the video hardware, which then can be used in 3D models or 2D :ref:`Sprite<class_Sprite>` or GUI :ref:`Control<class_Control>`.
|
|
|
|
Textures are often created by loading them from a file. See :ref:`@GDScript.load<class_@GDScript_method_load>`.
|
|
|
|
``Texture2D`` is a base for other resources. It cannot be used directly.
|
|
|
|
Methods
|
|
-------
|
|
|
|
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`draw<class_Texture2D_method_draw>` **(** :ref:`RID<class_RID>` canvas_item, :ref:`Vector2<class_Vector2>` position, :ref:`Color<class_Color>` modulate=Color( 1, 1, 1, 1 ), :ref:`bool<class_bool>` transpose=false, :ref:`Texture2D<class_Texture2D>` normal_map=null, :ref:`Texture2D<class_Texture2D>` specular_map=null, :ref:`Color<class_Color>` specular_color_shininess=Color( 1, 1, 1, 1 ), :ref:`CanvasItemTextureFilter<enum_VisualServer_CanvasItemTextureFilter>` texture_filter=0, :ref:`CanvasItemTextureRepeat<enum_VisualServer_CanvasItemTextureRepeat>` texture_repeat=0 **)** const |
|
|
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`draw_rect<class_Texture2D_method_draw_rect>` **(** :ref:`RID<class_RID>` canvas_item, :ref:`Rect2<class_Rect2>` rect, :ref:`bool<class_bool>` tile, :ref:`Color<class_Color>` modulate=Color( 1, 1, 1, 1 ), :ref:`bool<class_bool>` transpose=false, :ref:`Texture2D<class_Texture2D>` normal_map=null, :ref:`Texture2D<class_Texture2D>` specular_map=null, :ref:`Color<class_Color>` specular_color_shininess=Color( 1, 1, 1, 1 ), :ref:`CanvasItemTextureFilter<enum_VisualServer_CanvasItemTextureFilter>` texture_filter=0, :ref:`CanvasItemTextureRepeat<enum_VisualServer_CanvasItemTextureRepeat>` texture_repeat=0 **)** const |
|
|
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`draw_rect_region<class_Texture2D_method_draw_rect_region>` **(** :ref:`RID<class_RID>` canvas_item, :ref:`Rect2<class_Rect2>` rect, :ref:`Rect2<class_Rect2>` src_rect, :ref:`Color<class_Color>` modulate=Color( 1, 1, 1, 1 ), :ref:`bool<class_bool>` transpose=false, :ref:`Texture2D<class_Texture2D>` normal_map=null, :ref:`Texture2D<class_Texture2D>` specular_map=null, :ref:`Color<class_Color>` specular_color_shininess=Color( 1, 1, 1, 1 ), :ref:`CanvasItemTextureFilter<enum_VisualServer_CanvasItemTextureFilter>` texture_filter=0, :ref:`CanvasItemTextureRepeat<enum_VisualServer_CanvasItemTextureRepeat>` texture_repeat=0, :ref:`bool<class_bool>` clip_uv=true **)** const |
|
|
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Image<class_Image>` | :ref:`get_data<class_Texture2D_method_get_data>` **(** **)** const |
|
|
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`int<class_int>` | :ref:`get_height<class_Texture2D_method_get_height>` **(** **)** const |
|
|
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Vector2<class_Vector2>` | :ref:`get_size<class_Texture2D_method_get_size>` **(** **)** const |
|
|
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`int<class_int>` | :ref:`get_width<class_Texture2D_method_get_width>` **(** **)** const |
|
|
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`has_alpha<class_Texture2D_method_has_alpha>` **(** **)** const |
|
|
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
|
Method Descriptions
|
|
-------------------
|
|
|
|
.. _class_Texture2D_method_draw:
|
|
|
|
- void **draw** **(** :ref:`RID<class_RID>` canvas_item, :ref:`Vector2<class_Vector2>` position, :ref:`Color<class_Color>` modulate=Color( 1, 1, 1, 1 ), :ref:`bool<class_bool>` transpose=false, :ref:`Texture2D<class_Texture2D>` normal_map=null, :ref:`Texture2D<class_Texture2D>` specular_map=null, :ref:`Color<class_Color>` specular_color_shininess=Color( 1, 1, 1, 1 ), :ref:`CanvasItemTextureFilter<enum_VisualServer_CanvasItemTextureFilter>` texture_filter=0, :ref:`CanvasItemTextureRepeat<enum_VisualServer_CanvasItemTextureRepeat>` texture_repeat=0 **)** const
|
|
|
|
Draws the texture using a :ref:`CanvasItem<class_CanvasItem>` with the :ref:`VisualServer<class_VisualServer>` API at the specified ``position``.
|
|
|
|
----
|
|
|
|
.. _class_Texture2D_method_draw_rect:
|
|
|
|
- void **draw_rect** **(** :ref:`RID<class_RID>` canvas_item, :ref:`Rect2<class_Rect2>` rect, :ref:`bool<class_bool>` tile, :ref:`Color<class_Color>` modulate=Color( 1, 1, 1, 1 ), :ref:`bool<class_bool>` transpose=false, :ref:`Texture2D<class_Texture2D>` normal_map=null, :ref:`Texture2D<class_Texture2D>` specular_map=null, :ref:`Color<class_Color>` specular_color_shininess=Color( 1, 1, 1, 1 ), :ref:`CanvasItemTextureFilter<enum_VisualServer_CanvasItemTextureFilter>` texture_filter=0, :ref:`CanvasItemTextureRepeat<enum_VisualServer_CanvasItemTextureRepeat>` texture_repeat=0 **)** const
|
|
|
|
Draws the texture using a :ref:`CanvasItem<class_CanvasItem>` with the :ref:`VisualServer<class_VisualServer>` API.
|
|
|
|
----
|
|
|
|
.. _class_Texture2D_method_draw_rect_region:
|
|
|
|
- void **draw_rect_region** **(** :ref:`RID<class_RID>` canvas_item, :ref:`Rect2<class_Rect2>` rect, :ref:`Rect2<class_Rect2>` src_rect, :ref:`Color<class_Color>` modulate=Color( 1, 1, 1, 1 ), :ref:`bool<class_bool>` transpose=false, :ref:`Texture2D<class_Texture2D>` normal_map=null, :ref:`Texture2D<class_Texture2D>` specular_map=null, :ref:`Color<class_Color>` specular_color_shininess=Color( 1, 1, 1, 1 ), :ref:`CanvasItemTextureFilter<enum_VisualServer_CanvasItemTextureFilter>` texture_filter=0, :ref:`CanvasItemTextureRepeat<enum_VisualServer_CanvasItemTextureRepeat>` texture_repeat=0, :ref:`bool<class_bool>` clip_uv=true **)** const
|
|
|
|
Draws a part of the texture using a :ref:`CanvasItem<class_CanvasItem>` with the :ref:`VisualServer<class_VisualServer>` API.
|
|
|
|
----
|
|
|
|
.. _class_Texture2D_method_get_data:
|
|
|
|
- :ref:`Image<class_Image>` **get_data** **(** **)** const
|
|
|
|
Returns an :ref:`Image<class_Image>` with the data from this ``Texture2D``. :ref:`Image<class_Image>`\ s can be accessed and manipulated directly.
|
|
|
|
----
|
|
|
|
.. _class_Texture2D_method_get_height:
|
|
|
|
- :ref:`int<class_int>` **get_height** **(** **)** const
|
|
|
|
Returns the texture height.
|
|
|
|
----
|
|
|
|
.. _class_Texture2D_method_get_size:
|
|
|
|
- :ref:`Vector2<class_Vector2>` **get_size** **(** **)** const
|
|
|
|
Returns the texture size.
|
|
|
|
----
|
|
|
|
.. _class_Texture2D_method_get_width:
|
|
|
|
- :ref:`int<class_int>` **get_width** **(** **)** const
|
|
|
|
Returns the texture width.
|
|
|
|
----
|
|
|
|
.. _class_Texture2D_method_has_alpha:
|
|
|
|
- :ref:`bool<class_bool>` **has_alpha** **(** **)** const
|
|
|
|
Returns ``true`` if this ``Texture2D`` has an alpha channel.
|
|
|