.. _api_SpriteRender:

SpriteRender
============

Inherited: None

.. _api_SpriteRender_description:

Description
-----------

The SpriteRender component allows you to display images as sprites to use in both 2D and 3D scenes.



.. _api_SpriteRender_public:

Public Methods
--------------

+--------------------------------+--------------------------------------------------------------------+
|    :ref:`Vector4<api_Vector4>` | :ref:`color<api_SpriteRender_color>` () const                      |
+--------------------------------+--------------------------------------------------------------------+
|                            int | :ref:`drawMode<api_SpriteRender_drawMode>` () const                |
+--------------------------------+--------------------------------------------------------------------+
|                    std::string | :ref:`item<api_SpriteRender_item>` () const                        |
+--------------------------------+--------------------------------------------------------------------+
|                            int | :ref:`layer<api_SpriteRender_layer>` () const                      |
+--------------------------------+--------------------------------------------------------------------+
|                           void | :ref:`setColor<api_SpriteRender_setColor>` (const Vector4  color)  |
+--------------------------------+--------------------------------------------------------------------+
|                           void | :ref:`setDrawMode<api_SpriteRender_setDrawMode>` (int  mode)       |
+--------------------------------+--------------------------------------------------------------------+
|                           void | :ref:`setItem<api_SpriteRender_setItem>` (const std::string  item) |
+--------------------------------+--------------------------------------------------------------------+
|                           void | :ref:`setLayer<api_SpriteRender_setLayer>` (int  layer)            |
+--------------------------------+--------------------------------------------------------------------+
|                           void | :ref:`setSize<api_SpriteRender_setSize>` (const Vector2  size)     |
+--------------------------------+--------------------------------------------------------------------+
|                           void | :ref:`setSprite<api_SpriteRender_setSprite>` (Sprite * sheet)      |
+--------------------------------+--------------------------------------------------------------------+
|                           void | :ref:`setTexture<api_SpriteRender_setTexture>` (Texture * texture) |
+--------------------------------+--------------------------------------------------------------------+
|    :ref:`Vector2<api_Vector2>` | :ref:`size<api_SpriteRender_size>` () const                        |
+--------------------------------+--------------------------------------------------------------------+
|    :ref:`Sprite<api_Sprite>` * | :ref:`sprite<api_SpriteRender_sprite>` () const                    |
+--------------------------------+--------------------------------------------------------------------+
|  :ref:`Texture<api_Texture>` * | :ref:`texture<api_SpriteRender_texture>` () const                  |
+--------------------------------+--------------------------------------------------------------------+

.. _api_SpriteRender_enums:

Public Enums
------------

.. _api_SpriteRender_DrawMode:

**enum SpriteRender::DrawMode**

+----------------------+-------+------------------------------------------------------------------------------+
|             Constant | Value | Description                                                                  |
+----------------------+-------+------------------------------------------------------------------------------+
| SpriteRender::Simple | 0     | The SpriteRender will draw sprite as is.                                     |
+----------------------+-------+------------------------------------------------------------------------------+
| SpriteRender::Sliced | 1     | The SpriteRender will respect 9 patch slicing rules for the size property.   |
+----------------------+-------+------------------------------------------------------------------------------+
|  SpriteRender::Tiled | 2     | The SpriteRender will duplicate sprites to fill the size property rectangle. |
+----------------------+-------+------------------------------------------------------------------------------+



.. _api_SpriteRender_static:

Static Methods
--------------

None

.. _api_SpriteRender_methods:

Methods Description
-------------------

.. _api_SpriteRender_color:

 :ref:`Vector4<api_Vector4>`  **SpriteRender::color** () const

Returns the color of the sprite to be drawn.

**See also** setColor().

----

.. _api_SpriteRender_drawMode:

 int **SpriteRender::drawMode** () const

Returns a draw mode for the sprite. Please check SpriteRender::DrawMode for more details.

**See also** setDrawMode().

----

.. _api_SpriteRender_item:

 std::string **SpriteRender::item** () const

Returns the current item name of sprite from the sprite sheet.

**See also** setItem().

----

.. _api_SpriteRender_layer:

 int **SpriteRender::layer** () const

Returns the order layer for the sprite.

**See also** setLayer().

----

.. _api_SpriteRender_setColor:

 void **SpriteRender::setColor** (:ref:`Vector4<api_Vector4>`  *color*)

Changes the *color* of the sprite to be drawn.

**See also** *color*().

----

.. _api_SpriteRender_setDrawMode:

 void **SpriteRender::setDrawMode** (int  *mode*)

Sets a draw *mode* for the sprite. Please check SpriteRender::DrawMode for more details.

**See also** drawMode().

----

.. _api_SpriteRender_setItem:

 void **SpriteRender::setItem** (std::string  *item*)

Sets the current sub *item* name of sprite from the sprite sheet.

**See also** *item*().

----

.. _api_SpriteRender_setLayer:

 void **SpriteRender::setLayer** (int  *layer*)

Sets the order *layer* for the sprite.

**See also** *layer*().

----

.. _api_SpriteRender_setSize:

 void **SpriteRender::setSize** (:ref:`Vector2<api_Vector2>`  *size*)

Sets a new *size* of sprite.

**See also** *size*().

----

.. _api_SpriteRender_setSprite:

 void **SpriteRender::setSprite** (:ref:`Sprite<api_Sprite>` * *sheet*)

Replaces current sprite *sheet* with a new one.

**See also** sprite().

----

.. _api_SpriteRender_setTexture:

 void **SpriteRender::setTexture** (:ref:`Texture<api_Texture>` * *texture*)

Replaces current *texture* with a new one.

**See also** *texture*().

----

.. _api_SpriteRender_size:

 :ref:`Vector2<api_Vector2>`  **SpriteRender::size** () const

Returns size of sprite.

**See also** setSize().

----

.. _api_SpriteRender_sprite:

 :ref:`Sprite<api_Sprite>` * **SpriteRender::sprite** () const

Returns a sprite sheet.

**See also** setSprite().

----

.. _api_SpriteRender_texture:

 :ref:`Texture<api_Texture>` * **SpriteRender::texture** () const

Returns current assigned texture.

**See also** setTexture().