.. _stdlib_sprite_renderer_component:

==============
SpriteRenderer
==============

.. das:module:: sprite_renderer_component




+++++++
Classes
+++++++

.. _struct-sprite_renderer_component-SpriteRenderer:

.. das:attribute:: SpriteRenderer : NativeComponent

This component allows to render textures as sprites.

Usage example::

    node.add_component(new SpriteRenderer(
        textureId = spriteTexture,
        color = spriteColor,
        flipX = false,
        flipY = false,
        uvRect = float4(0, 0, 1, 1),
        useTextureSizeForScaling = true,
        renderOrder = 0
    ))



:Properties:

.. _function-sprite_renderer_component__dot__rq_textureId_SpriteRenderer:

.. das:operator:: SpriteRenderer.textureId() : TextureId




.. _function-sprite_renderer_component__dot__rq_textureId_rq_clone_SpriteRenderer_TextureId:

.. das:operator:: SpriteRenderer.textureId =(value: TextureId)

Sprite texture resource


:Arguments: * **value** :  :ref:`TextureId <handle-public_resources-TextureId>`

.. _function-sprite_renderer_component__dot__rq_color_SpriteRenderer:

.. das:operator:: SpriteRenderer.color() : float4




.. _function-sprite_renderer_component__dot__rq_color_rq_clone_SpriteRenderer_float4:

.. das:operator:: SpriteRenderer.color =(value: float4)

Color for the sprite


:Arguments: * **value** : float4

.. _function-sprite_renderer_component__dot__rq_flipX_SpriteRenderer:

.. das:operator:: SpriteRenderer.flipX() : bool




.. _function-sprite_renderer_component__dot__rq_flipX_rq_clone_SpriteRenderer_bool:

.. das:operator:: SpriteRenderer.flipX =(value: bool)

Flip sprite horizontally


:Arguments: * **value** : bool

.. _function-sprite_renderer_component__dot__rq_flipY_SpriteRenderer:

.. das:operator:: SpriteRenderer.flipY() : bool




.. _function-sprite_renderer_component__dot__rq_flipY_rq_clone_SpriteRenderer_bool:

.. das:operator:: SpriteRenderer.flipY =(value: bool)

Flip sprite vertically


:Arguments: * **value** : bool

.. _function-sprite_renderer_component__dot__rq_uvRect_SpriteRenderer:

.. das:operator:: SpriteRenderer.uvRect() : float4




.. _function-sprite_renderer_component__dot__rq_uvRect_rq_clone_SpriteRenderer_float4:

.. das:operator:: SpriteRenderer.uvRect =(value: float4)

.xy is uv offset and .zw is uv scale, default is (0, 0, 1, 1)


:Arguments: * **value** : float4

.. _function-sprite_renderer_component__dot__rq_useTextureSizeForScaling_SpriteRenderer:

.. das:operator:: SpriteRenderer.useTextureSizeForScaling() : bool




.. _function-sprite_renderer_component__dot__rq_useTextureSizeForScaling_rq_clone_SpriteRenderer_bool:

.. das:operator:: SpriteRenderer.useTextureSizeForScaling =(value: bool)

Use texture size for scaling. Default is true. It multiply localScale.xy by texture size divided by 100.


:Arguments: * **value** : bool

.. _function-sprite_renderer_component__dot__rq_renderOrder_SpriteRenderer:

.. das:operator:: SpriteRenderer.renderOrder() : int




.. _function-sprite_renderer_component__dot__rq_renderOrder_rq_clone_SpriteRenderer_int:

.. das:operator:: SpriteRenderer.renderOrder =(value: int)

Explicit sorting order for the sprite. Default is 0. Then bigger this value, the later sprite will be rendered.


:Arguments: * **value** : int