godot-docs/classes/class_sprite3d.rst

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.

.. _class_Sprite3D:

Sprite3D
========

**Inherits:** :ref:`SpriteBase3D<class_spritebase3d>` **<** :ref:`GeometryInstance<class_geometryinstance>` **<** :ref:`VisualInstance<class_visualinstance>` **<** :ref:`Spatial<class_spatial>` **<** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`

**Category:** Core

Brief Description
-----------------



Member Functions
----------------

+--------------------------------+-----------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`          | :ref:`get_frame<class_Sprite3D_get_frame>`  **(** **)** const                                       |
+--------------------------------+-----------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`          | :ref:`get_hframes<class_Sprite3D_get_hframes>`  **(** **)** const                                   |
+--------------------------------+-----------------------------------------------------------------------------------------------------+
| :ref:`Rect2<class_rect2>`      | :ref:`get_region_rect<class_Sprite3D_get_region_rect>`  **(** **)** const                           |
+--------------------------------+-----------------------------------------------------------------------------------------------------+
| :ref:`Texture<class_texture>`  | :ref:`get_texture<class_Sprite3D_get_texture>`  **(** **)** const                                   |
+--------------------------------+-----------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`          | :ref:`get_vframes<class_Sprite3D_get_vframes>`  **(** **)** const                                   |
+--------------------------------+-----------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`        | :ref:`is_region<class_Sprite3D_is_region>`  **(** **)** const                                       |
+--------------------------------+-----------------------------------------------------------------------------------------------------+
| void                           | :ref:`set_frame<class_Sprite3D_set_frame>`  **(** :ref:`int<class_int>` frame  **)**                |
+--------------------------------+-----------------------------------------------------------------------------------------------------+
| void                           | :ref:`set_hframes<class_Sprite3D_set_hframes>`  **(** :ref:`int<class_int>` hframes  **)**          |
+--------------------------------+-----------------------------------------------------------------------------------------------------+
| void                           | :ref:`set_region<class_Sprite3D_set_region>`  **(** :ref:`bool<class_bool>` enabled  **)**          |
+--------------------------------+-----------------------------------------------------------------------------------------------------+
| void                           | :ref:`set_region_rect<class_Sprite3D_set_region_rect>`  **(** :ref:`Rect2<class_rect2>` rect  **)** |
+--------------------------------+-----------------------------------------------------------------------------------------------------+
| void                           | :ref:`set_texture<class_Sprite3D_set_texture>`  **(** :ref:`Texture<class_texture>` texture  **)**  |
+--------------------------------+-----------------------------------------------------------------------------------------------------+
| void                           | :ref:`set_vframes<class_Sprite3D_set_vframes>`  **(** :ref:`int<class_int>` vframes  **)**          |
+--------------------------------+-----------------------------------------------------------------------------------------------------+

Signals
-------

-  **frame_changed**  **(** **)**

Member Function Description
---------------------------

.. _class_Sprite3D_get_frame:

- :ref:`int<class_int>`  **get_frame**  **(** **)** const

.. _class_Sprite3D_get_hframes:

- :ref:`int<class_int>`  **get_hframes**  **(** **)** const

.. _class_Sprite3D_get_region_rect:

- :ref:`Rect2<class_rect2>`  **get_region_rect**  **(** **)** const

.. _class_Sprite3D_get_texture:

- :ref:`Texture<class_texture>`  **get_texture**  **(** **)** const

.. _class_Sprite3D_get_vframes:

- :ref:`int<class_int>`  **get_vframes**  **(** **)** const

.. _class_Sprite3D_is_region:

- :ref:`bool<class_bool>`  **is_region**  **(** **)** const

.. _class_Sprite3D_set_frame:

- void  **set_frame**  **(** :ref:`int<class_int>` frame  **)**

.. _class_Sprite3D_set_hframes:

- void  **set_hframes**  **(** :ref:`int<class_int>` hframes  **)**

.. _class_Sprite3D_set_region:

- void  **set_region**  **(** :ref:`bool<class_bool>` enabled  **)**

.. _class_Sprite3D_set_region_rect:

- void  **set_region_rect**  **(** :ref:`Rect2<class_rect2>` rect  **)**

.. _class_Sprite3D_set_texture:

- void  **set_texture**  **(** :ref:`Texture<class_texture>` texture  **)**

.. _class_Sprite3D_set_vframes:

- void  **set_vframes**  **(** :ref:`int<class_int>` vframes  **)**