class_largetexture.rst 7.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168
  1. :github_url: hide
  2. .. DO NOT EDIT THIS FILE!!!
  3. .. Generated automatically from Godot engine sources.
  4. .. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py.
  5. .. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/LargeTexture.xml.
  6. .. _class_LargeTexture:
  7. LargeTexture
  8. ============
  9. **Inherits:** :ref:`Texture<class_Texture>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
  10. *Deprecated.* A :ref:`Texture<class_Texture>` capable of storing many smaller textures with offsets.
  11. .. rst-class:: classref-introduction-group
  12. Description
  13. -----------
  14. *Deprecated (will be removed in Godot 4.0).* A :ref:`Texture<class_Texture>` capable of storing many smaller textures with offsets.
  15. You can dynamically add pieces (:ref:`Texture<class_Texture>`\ s) to this **LargeTexture** using different offsets.
  16. .. rst-class:: classref-reftable-group
  17. Properties
  18. ----------
  19. .. table::
  20. :widths: auto
  21. +-----------------------+-------+----------------------------------------------------------------+
  22. | :ref:`int<class_int>` | flags | ``0`` (overrides :ref:`Texture<class_Texture_property_flags>`) |
  23. +-----------------------+-------+----------------------------------------------------------------+
  24. .. rst-class:: classref-reftable-group
  25. Methods
  26. -------
  27. .. table::
  28. :widths: auto
  29. +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
  30. | :ref:`int<class_int>` | :ref:`add_piece<class_LargeTexture_method_add_piece>` **(** :ref:`Vector2<class_Vector2>` ofs, :ref:`Texture<class_Texture>` texture **)** |
  31. +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
  32. | void | :ref:`clear<class_LargeTexture_method_clear>` **(** **)** |
  33. +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
  34. | :ref:`int<class_int>` | :ref:`get_piece_count<class_LargeTexture_method_get_piece_count>` **(** **)** |const| |
  35. +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
  36. | :ref:`Vector2<class_Vector2>` | :ref:`get_piece_offset<class_LargeTexture_method_get_piece_offset>` **(** :ref:`int<class_int>` idx **)** |const| |
  37. +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
  38. | :ref:`Texture<class_Texture>` | :ref:`get_piece_texture<class_LargeTexture_method_get_piece_texture>` **(** :ref:`int<class_int>` idx **)** |const| |
  39. +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
  40. | void | :ref:`set_piece_offset<class_LargeTexture_method_set_piece_offset>` **(** :ref:`int<class_int>` idx, :ref:`Vector2<class_Vector2>` ofs **)** |
  41. +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
  42. | void | :ref:`set_piece_texture<class_LargeTexture_method_set_piece_texture>` **(** :ref:`int<class_int>` idx, :ref:`Texture<class_Texture>` texture **)** |
  43. +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
  44. | void | :ref:`set_size<class_LargeTexture_method_set_size>` **(** :ref:`Vector2<class_Vector2>` size **)** |
  45. +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
  46. .. rst-class:: classref-section-separator
  47. ----
  48. .. rst-class:: classref-descriptions-group
  49. Method Descriptions
  50. -------------------
  51. .. _class_LargeTexture_method_add_piece:
  52. .. rst-class:: classref-method
  53. :ref:`int<class_int>` **add_piece** **(** :ref:`Vector2<class_Vector2>` ofs, :ref:`Texture<class_Texture>` texture **)**
  54. Adds ``texture`` to this **LargeTexture**, starting on offset ``ofs``.
  55. .. rst-class:: classref-item-separator
  56. ----
  57. .. _class_LargeTexture_method_clear:
  58. .. rst-class:: classref-method
  59. void **clear** **(** **)**
  60. Clears the **LargeTexture**.
  61. .. rst-class:: classref-item-separator
  62. ----
  63. .. _class_LargeTexture_method_get_piece_count:
  64. .. rst-class:: classref-method
  65. :ref:`int<class_int>` **get_piece_count** **(** **)** |const|
  66. Returns the number of pieces currently in this **LargeTexture**.
  67. .. rst-class:: classref-item-separator
  68. ----
  69. .. _class_LargeTexture_method_get_piece_offset:
  70. .. rst-class:: classref-method
  71. :ref:`Vector2<class_Vector2>` **get_piece_offset** **(** :ref:`int<class_int>` idx **)** |const|
  72. Returns the offset of the piece with the index ``idx``.
  73. .. rst-class:: classref-item-separator
  74. ----
  75. .. _class_LargeTexture_method_get_piece_texture:
  76. .. rst-class:: classref-method
  77. :ref:`Texture<class_Texture>` **get_piece_texture** **(** :ref:`int<class_int>` idx **)** |const|
  78. Returns the :ref:`Texture<class_Texture>` of the piece with the index ``idx``.
  79. .. rst-class:: classref-item-separator
  80. ----
  81. .. _class_LargeTexture_method_set_piece_offset:
  82. .. rst-class:: classref-method
  83. void **set_piece_offset** **(** :ref:`int<class_int>` idx, :ref:`Vector2<class_Vector2>` ofs **)**
  84. Sets the offset of the piece with the index ``idx`` to ``ofs``.
  85. .. rst-class:: classref-item-separator
  86. ----
  87. .. _class_LargeTexture_method_set_piece_texture:
  88. .. rst-class:: classref-method
  89. void **set_piece_texture** **(** :ref:`int<class_int>` idx, :ref:`Texture<class_Texture>` texture **)**
  90. Sets the :ref:`Texture<class_Texture>` of the piece with index ``idx`` to ``texture``.
  91. .. rst-class:: classref-item-separator
  92. ----
  93. .. _class_LargeTexture_method_set_size:
  94. .. rst-class:: classref-method
  95. void **set_size** **(** :ref:`Vector2<class_Vector2>` size **)**
  96. Sets the size of this **LargeTexture**.
  97. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  98. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  99. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  100. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`