SpriteRenderer

Classes

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:

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

Sprite texture resource

Arguments:
SpriteRenderer.color: float4
SpriteRenderer.color =(value: float4)

Color for the sprite

Arguments:

  • value : float4

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

Flip sprite horizontally

Arguments:

  • value : bool

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

Flip sprite vertically

Arguments:

  • value : bool

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

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

Arguments:

  • value : float4

SpriteRenderer.useTextureSizeForScaling: bool
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

SpriteRenderer.renderOrder: int
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