Late binding is the process of loading or swapping in a Sprite AtlasA texture that is composed of several smaller textures. Also referred to as a texture atlas, image sprite, sprite sheet or packed texture. More info
See in Glossary at runtime via the Sprite Atlas API. It’s necessary when the atlas isn’t available during start-up, such as when loading assets from AssetBundles. You can choose to bind different Sprite Atlases based on specific criteria, such as loading a high or low-resolution SpriteA 2D graphic objects. If you are used to working in 3D, Sprites are essentially just standard textures but there are special techniques for combining and managing sprite textures for efficiency and convenience during development. More info
See in Glossary Atlas ford different platforms to improve performance and efficiency.
After you pack your sprites into a Sprite Atlas in your project, you can decide whether to include the Sprite Atlas with the published build. To exclude the Sprite Atlas from the build, clear Include in Build in the Sprite Atlas’ properties. When not included in a build, the Sprite Atlas isn’t loaded at runtime and sprites that reference textures packed into the atlas will appear blank until you use late binding to load the atlas. Note that this also means that Unity Editor won’t automatically load the Sprite Atlas and that your sprites will appear blank when you enter Play mode.
Additional samples of the different ways and scenarios to use Sprite Atlases and late binding are available for download from the 2D Common package’s Samples tab.
atlasRequested
is a callback that tells you when a sprite, which isn’t included in the build, is requested. You need to manually load the Sprite Atlas with late binding, and send the sprite to the Unity Editor.
The following example demonstrates how to set up the callback to load the Sprite Atlas from an AssetBundle with late binding. Note that this script is for loading and binding a Sprite Atlas to sprites which already exist in the build or project. You can create sprites that don’t exist in the project from a Sprite Atlas by retrieving the sprite atlas’ contents at runtime with GetSprites
void OnEnable()
{
SpriteAtlasManager.atlasRequested += RequestAtlas;
}
void OnDisable()
{
SpriteAtlasManager.atlasRequested -= RequestAtlas;
}
void RequestAtlas(string tag, System.Action callback)
{
if (spriteAtlas == null)
{
StartCoroutine(LoadFromStreammingAsset(callback));
}
else
{
callback(spriteAtlas);
}
}
IEnumerator LoadFromStreammingAsset(System.Action callback)
{
string path = Application.streamingAssetsPath + "/" + bundleName;
print(path);
AssetBundleCreateRequest bundleLoadRequest = AssetBundle.LoadFromFileAsync(Application.streamingAssetsPath + "/" + bundleName);
yield return bundleLoadRequest;
bundle = bundleLoadRequest.assetBundle;
if (bundle == null)
{
Debug.Log("Failed to load AssetBundle!");
yield break;
}
SpriteAtlas spriteAtlas = bundle.LoadAsset(bundleName);
callback(spriteAtlas);
}
If the sprites packed into a Sprite Atlas don’t exist in the current build or project, use GetSprites to create sprites bound to a Sprite Atlas at runtime with the following steps.
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.