class_imagetexture.rst 3.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566
  1. :github_url: hide
  2. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  3. .. DO NOT EDIT THIS FILE, but the ImageTexture.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_ImageTexture:
  6. ImageTexture
  7. ============
  8. **Inherits:** :ref:`Texture2D<class_Texture2D>` **<** :ref:`Texture<class_Texture>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
  9. A :ref:`Texture2D<class_Texture2D>` based on an :ref:`Image<class_Image>`.
  10. Description
  11. -----------
  12. 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>`.
  13. Methods
  14. -------
  15. +----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
  16. | void | :ref:`create_from_image<class_ImageTexture_method_create_from_image>` **(** :ref:`Image<class_Image>` image **)** |
  17. +----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
  18. | :ref:`Format<enum_Image_Format>` | :ref:`get_format<class_ImageTexture_method_get_format>` **(** **)** const |
  19. +----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
  20. | void | :ref:`set_size_override<class_ImageTexture_method_set_size_override>` **(** :ref:`Vector2<class_Vector2>` size **)** |
  21. +----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
  22. | void | :ref:`update<class_ImageTexture_method_update>` **(** :ref:`Image<class_Image>` image, :ref:`bool<class_bool>` immediate=false **)** |
  23. +----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
  24. Method Descriptions
  25. -------------------
  26. .. _class_ImageTexture_method_create_from_image:
  27. - void **create_from_image** **(** :ref:`Image<class_Image>` image **)**
  28. Create a new ``ImageTexture`` from an :ref:`Image<class_Image>`.
  29. ----
  30. .. _class_ImageTexture_method_get_format:
  31. - :ref:`Format<enum_Image_Format>` **get_format** **(** **)** const
  32. Returns the format of the ``ImageTexture``, one of :ref:`Format<enum_Image_Format>`.
  33. ----
  34. .. _class_ImageTexture_method_set_size_override:
  35. - void **set_size_override** **(** :ref:`Vector2<class_Vector2>` size **)**
  36. Resizes the ``ImageTexture`` to the specified dimensions.
  37. ----
  38. .. _class_ImageTexture_method_update:
  39. - void **update** **(** :ref:`Image<class_Image>` image, :ref:`bool<class_bool>` immediate=false **)**
  40. Replaces the texture's data with a new ``image``. If ``immediate`` is ``true``, it will take effect immediately after the call.