| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108 |
- :github_url: hide
- .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
- .. DO NOT EDIT THIS FILE, but the LargeTexture.xml source instead.
- .. The source is found in doc/classes or modules/<name>/doc_classes.
- .. _class_LargeTexture:
- LargeTexture
- ============
- **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>` capable of storing many smaller textures with offsets.
- Description
- -----------
- A :ref:`Texture2D<class_Texture2D>` capable of storing many smaller textures with offsets.
- You can dynamically add pieces (:ref:`Texture2D<class_Texture2D>`\ s) to this ``LargeTexture`` using different offsets.
- Methods
- -------
- +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`int<class_int>` | :ref:`add_piece<class_LargeTexture_method_add_piece>` **(** :ref:`Vector2<class_Vector2>` ofs, :ref:`Texture2D<class_Texture2D>` texture **)** |
- +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`clear<class_LargeTexture_method_clear>` **(** **)** |
- +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`int<class_int>` | :ref:`get_piece_count<class_LargeTexture_method_get_piece_count>` **(** **)** const |
- +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Vector2<class_Vector2>` | :ref:`get_piece_offset<class_LargeTexture_method_get_piece_offset>` **(** :ref:`int<class_int>` idx **)** const |
- +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Texture2D<class_Texture2D>` | :ref:`get_piece_texture<class_LargeTexture_method_get_piece_texture>` **(** :ref:`int<class_int>` idx **)** const |
- +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`set_piece_offset<class_LargeTexture_method_set_piece_offset>` **(** :ref:`int<class_int>` idx, :ref:`Vector2<class_Vector2>` ofs **)** |
- +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`set_piece_texture<class_LargeTexture_method_set_piece_texture>` **(** :ref:`int<class_int>` idx, :ref:`Texture2D<class_Texture2D>` texture **)** |
- +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`set_size<class_LargeTexture_method_set_size>` **(** :ref:`Vector2<class_Vector2>` size **)** |
- +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
- Method Descriptions
- -------------------
- .. _class_LargeTexture_method_add_piece:
- - :ref:`int<class_int>` **add_piece** **(** :ref:`Vector2<class_Vector2>` ofs, :ref:`Texture2D<class_Texture2D>` texture **)**
- Adds ``texture`` to this ``LargeTexture``, starting on offset ``ofs``.
- ----
- .. _class_LargeTexture_method_clear:
- - void **clear** **(** **)**
- Clears the ``LargeTexture``.
- ----
- .. _class_LargeTexture_method_get_piece_count:
- - :ref:`int<class_int>` **get_piece_count** **(** **)** const
- Returns the number of pieces currently in this ``LargeTexture``.
- ----
- .. _class_LargeTexture_method_get_piece_offset:
- - :ref:`Vector2<class_Vector2>` **get_piece_offset** **(** :ref:`int<class_int>` idx **)** const
- Returns the offset of the piece with the index ``idx``.
- ----
- .. _class_LargeTexture_method_get_piece_texture:
- - :ref:`Texture2D<class_Texture2D>` **get_piece_texture** **(** :ref:`int<class_int>` idx **)** const
- Returns the :ref:`Texture2D<class_Texture2D>` of the piece with the index ``idx``.
- ----
- .. _class_LargeTexture_method_set_piece_offset:
- - void **set_piece_offset** **(** :ref:`int<class_int>` idx, :ref:`Vector2<class_Vector2>` ofs **)**
- Sets the offset of the piece with the index ``idx`` to ``ofs``.
- ----
- .. _class_LargeTexture_method_set_piece_texture:
- - void **set_piece_texture** **(** :ref:`int<class_int>` idx, :ref:`Texture2D<class_Texture2D>` texture **)**
- Sets the :ref:`Texture2D<class_Texture2D>` of the piece with index ``idx`` to ``texture``.
- ----
- .. _class_LargeTexture_method_set_size:
- - void **set_size** **(** :ref:`Vector2<class_Vector2>` size **)**
- Sets the size of this ``LargeTexture``.
|
