mirror of
https://github.com/stan220/godot-docs.git
synced 2026-09-08 17:28:58 +00:00
67 lines
3.2 KiB
ReStructuredText
67 lines
3.2 KiB
ReStructuredText
:github_url: hide
|
|
|
|
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
|
|
.. DO NOT EDIT THIS FILE, but the ImageTexture.xml source instead.
|
|
.. The source is found in doc/classes or modules/<name>/doc_classes.
|
|
|
|
.. _class_ImageTexture:
|
|
|
|
ImageTexture
|
|
============
|
|
|
|
**Inherits:** :ref:`Texture2D<class_Texture2D>` **<** :ref:`Texture<class_Texture>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
|
|
|
|
A :ref:`Texture2D<class_Texture2D>` based on an :ref:`Image<class_Image>`.
|
|
|
|
Description
|
|
-----------
|
|
|
|
A :ref:`Texture2D<class_Texture2D>` based on an :ref:`Image<class_Image>`. Can be created from an :ref:`Image<class_Image>` with :ref:`create_from_image<class_ImageTexture_method_create_from_image>`.
|
|
|
|
Methods
|
|
-------
|
|
|
|
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`create_from_image<class_ImageTexture_method_create_from_image>` **(** :ref:`Image<class_Image>` image **)** |
|
|
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Format<enum_Image_Format>` | :ref:`get_format<class_ImageTexture_method_get_format>` **(** **)** const |
|
|
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`set_size_override<class_ImageTexture_method_set_size_override>` **(** :ref:`Vector2<class_Vector2>` size **)** |
|
|
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`update<class_ImageTexture_method_update>` **(** :ref:`Image<class_Image>` image, :ref:`bool<class_bool>` immediate=false **)** |
|
|
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
|
Method Descriptions
|
|
-------------------
|
|
|
|
.. _class_ImageTexture_method_create_from_image:
|
|
|
|
- void **create_from_image** **(** :ref:`Image<class_Image>` image **)**
|
|
|
|
Create a new ``ImageTexture`` from an :ref:`Image<class_Image>`.
|
|
|
|
----
|
|
|
|
.. _class_ImageTexture_method_get_format:
|
|
|
|
- :ref:`Format<enum_Image_Format>` **get_format** **(** **)** const
|
|
|
|
Returns the format of the ``ImageTexture``, one of :ref:`Format<enum_Image_Format>`.
|
|
|
|
----
|
|
|
|
.. _class_ImageTexture_method_set_size_override:
|
|
|
|
- void **set_size_override** **(** :ref:`Vector2<class_Vector2>` size **)**
|
|
|
|
Resizes the ``ImageTexture`` to the specified dimensions.
|
|
|
|
----
|
|
|
|
.. _class_ImageTexture_method_update:
|
|
|
|
- void **update** **(** :ref:`Image<class_Image>` image, :ref:`bool<class_bool>` immediate=false **)**
|
|
|
|
Replaces the texture's data with a new ``image``. If ``immediate`` is ``true``, it will take effect immediately after the call.
|
|
|