Documentation

Unity Engine


User Manual

Script Reference

Unity Engine


GetSprites

Clone all the Sprite in this atlas and fill them into the supplied array.
Read time 1 minuteLast updated 12 days ago

Definition

GetSprites(Sprite[])

Clone all the Sprite in this atlas and fill them into the supplied array.
public int GetSprites(Sprite[] sprites)

Parameters

sprites

Array of Sprite that will be filled.

Returns

Type

Description

intThe size of the returned array.

Remarks

The array will not be resized if it doesn't contain enough elements to be filled. Please use SpriteAtlas.spriteCount to determine the size for the array.
Due to the nature of the packing algorithm, Sprites in this list are sorted by their area size, in descending order.

GetSprites(Sprite[], string)

Clone all the Sprite matching the name in this atlas and fill them into the supplied array.
public int GetSprites(Sprite[] sprites, string name)

Parameters

sprites

Array of Sprite that will be filled.

name

The name of the Sprite.

Returns

Type

Description

int