Legacy Documentation: Version 2017.2 (Go to current version)
LanguageEnglish
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

SpriteAtlas.GetSprites

Other Versions
Leave feedback
Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

public method GetSprites(sprites: Sprite[]): int;
public int GetSprites(Sprite[] sprites);

Parameters

sprites Array of Sprite that will be filled.

Returns

int The size of the returned array.

Description

Clone all the Sprite in this atlas and fill them into the supplied array.

The clones will use the packed texture of this atlas. Using the action of SpriteAtlasManager.RequestAtlasCallback will not affect these clones.

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.

public method GetSprites(sprites: Sprite[], name: string): int;
public int GetSprites(Sprite[] sprites, string name);

Parameters

sprites Array of Sprite that will be filled.
name The name of the Sprite.

Description

Clone all the Sprite matching the name in this atlas and fill them into the supplied array.

Did you find this page useful? Please give it a rating:

Is something described here not working as you expect it to? It might be a Known Issue. Please check with the Issue Tracker at issuetracker.unity3d.com.

Copyright © 2017 Unity Technologies. Publication: 2017.2-001U. Built: 2017-12-08.
Tutorials Community Answers Knowledge Base Forums Asset Store LegalPrivacy PolicyCookiesDo Not Sell or Share My Personal Information