Version: 2021.1
LanguageEnglish
  • C#

SpriteAtlasAsset

class in UnityEditor.U2D

/

Inherits from:Object

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

Description

SpriteAtlasAsset stores inputs for generating SpriteAtlas and generates atlas textures on Import.

Properties

isVariantChecks whether the Sprite Atlas Importer set the Sprite Atlas as a Variant.

Public Methods

AddAdd an array of Assets to the packable objects list.
GetPackingSettingsGets the current SpriteAtlasPackingSettings to use when packing SpriteAtlas.
GetPlatformSettingsGets the platform settings of the build target specified.
GetTextureSettingsGets the SpriteAtlasTextureSettings of packed Textures generated by this SpriteAtlasAsset.
RemoveRemoves objects from the Atlas's packable objects list.
SetIncludeInBuildDefines if the SpriteAtlas's packed Textures that the Importer generates are included in the build with the Sprite after packing is done.
SetIsVariantSets whether this Sprite Atlas is a Variant or not.
SetMasterAtlasSets an Atlas to be the Master Atlas.
SetPackingSettingsSets the SpriteAtlasPackingSettings to use when packing this SpriteAtlas.
SetPlatformSettingsSet the platform specific settings.
SetTextureSettingsSets the SpriteAtlasTextureSettings for the packed Texture generated by this SpriteAtlas.
SetVariantScaleSets the value used to downscale the Master's Texture.

Static Methods

LoadLoads SpriteAtlasAsset at the given path. File extension of SpriteAtlasAsset is *.spriteatlasv2.
SaveSaves SpriteAtlasAsset to disk. File extension of SpriteAtlasAsset is *.spriteatlasv2.

Inherited Members

Properties

hideFlagsShould the object be hidden, saved with the Scene or modifiable by the user?
nameThe name of the object.

Public Methods

GetInstanceIDGets the instance ID of the object.
ToStringReturns the name of the object.

Static Methods

DestroyRemoves a GameObject, component or asset.
DestroyImmediateDestroys the object obj immediately. You are strongly recommended to use Destroy instead.
DontDestroyOnLoadDo not destroy the target Object when loading a new Scene.
FindObjectOfTypeReturns the first active loaded object of Type type.
FindObjectsOfTypeGets a list of all loaded objects of Type type.
InstantiateClones the object original and returns the clone.

Operators

boolDoes the object exist?
operator !=Compares if two objects refer to a different object.
operator ==Compares two object references to see if they refer to the same object.