mirror of
https://github.com/godotengine/godot-docs.git
synced 2025-12-31 17:49:03 +03:00
99 lines
5.2 KiB
ReStructuredText
99 lines
5.2 KiB
ReStructuredText
.. 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:`Texture<class_texture>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
|
|
|
|
**Category:** Core
|
|
|
|
Brief Description
|
|
-----------------
|
|
|
|
A Texture capable of storing many smaller Textures with offsets.
|
|
|
|
Member Functions
|
|
----------------
|
|
|
|
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`int<class_int>` | :ref:`add_piece<class_LargeTexture_add_piece>` **(** :ref:`Vector2<class_vector2>` ofs, :ref:`Texture<class_texture>` texture **)** |
|
|
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`clear<class_LargeTexture_clear>` **(** **)** |
|
|
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`int<class_int>` | :ref:`get_piece_count<class_LargeTexture_get_piece_count>` **(** **)** const |
|
|
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Vector2<class_vector2>` | :ref:`get_piece_offset<class_LargeTexture_get_piece_offset>` **(** :ref:`int<class_int>` idx **)** const |
|
|
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Texture<class_texture>` | :ref:`get_piece_texture<class_LargeTexture_get_piece_texture>` **(** :ref:`int<class_int>` idx **)** const |
|
|
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`set_piece_offset<class_LargeTexture_set_piece_offset>` **(** :ref:`int<class_int>` idx, :ref:`Vector2<class_vector2>` ofs **)** |
|
|
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`set_piece_texture<class_LargeTexture_set_piece_texture>` **(** :ref:`int<class_int>` idx, :ref:`Texture<class_texture>` texture **)** |
|
|
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`set_size<class_LargeTexture_set_size>` **(** :ref:`Vector2<class_vector2>` size **)** |
|
|
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
|
Description
|
|
-----------
|
|
|
|
A Texture capable of storing many smaller Textures with offsets.
|
|
|
|
You can dynamically add pieces(:ref:`Texture<class_texture>`) to this ``LargeTexture`` using different offsets.
|
|
|
|
Member Function Description
|
|
---------------------------
|
|
|
|
.. _class_LargeTexture_add_piece:
|
|
|
|
- :ref:`int<class_int>` **add_piece** **(** :ref:`Vector2<class_vector2>` ofs, :ref:`Texture<class_texture>` texture **)**
|
|
|
|
Add another :ref:`Texture<class_texture>` to this ``LargeTexture``, starting on offset "ofs".
|
|
|
|
.. _class_LargeTexture_clear:
|
|
|
|
- void **clear** **(** **)**
|
|
|
|
Clears the ``LargeTexture``.
|
|
|
|
.. _class_LargeTexture_get_piece_count:
|
|
|
|
- :ref:`int<class_int>` **get_piece_count** **(** **)** const
|
|
|
|
Returns the number of pieces currently in this ``LargeTexture``.
|
|
|
|
.. _class_LargeTexture_get_piece_offset:
|
|
|
|
- :ref:`Vector2<class_vector2>` **get_piece_offset** **(** :ref:`int<class_int>` idx **)** const
|
|
|
|
Returns the offset of the piece with index "idx".
|
|
|
|
.. _class_LargeTexture_get_piece_texture:
|
|
|
|
- :ref:`Texture<class_texture>` **get_piece_texture** **(** :ref:`int<class_int>` idx **)** const
|
|
|
|
Returns the :ref:`Texture<class_texture>` of the piece with index "idx".
|
|
|
|
.. _class_LargeTexture_set_piece_offset:
|
|
|
|
- void **set_piece_offset** **(** :ref:`int<class_int>` idx, :ref:`Vector2<class_vector2>` ofs **)**
|
|
|
|
Sets the offset of the piece with index "idx" to "ofs".
|
|
|
|
.. _class_LargeTexture_set_piece_texture:
|
|
|
|
- void **set_piece_texture** **(** :ref:`int<class_int>` idx, :ref:`Texture<class_texture>` texture **)**
|
|
|
|
Sets the :ref:`Texture<class_texture>` of the piece with index "idx" to "ofs".
|
|
|
|
.. _class_LargeTexture_set_size:
|
|
|
|
- void **set_size** **(** :ref:`Vector2<class_vector2>` size **)**
|
|
|
|
Sets the size of this ``LargeTexture``.
|
|
|
|
|