By using the 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 Editor Data Provider API, the user can add, change and remove Sprite data in a custom importer or editor tool. Refer to the code examples below to see how the API is applied.
Important: Some of the following examples contains an additional section of code which is needed if you are using Unity 2021.2 or newer. If you are using Unity 2021.1 or older, you should remove the indicated section to ensure the code compiles properly.
The following examples show you how to use the API to get each respective instance.
using UnityEditor;
using UnityEditor.U2D.Sprites;
using UnityEngine;
public class MyAssetPostProcessor : AssetPostprocessor
{
private void OnPreprocessTexture()
{
var factory = new SpriteDataProviderFactories();
factory.Init();
var dataProvider = factory.GetSpriteEditorDataProviderFromObject(assetImporter);
dataProvider.InitSpriteEditorDataProvider();
/* Use the data provider */
// Apply the changes made to the data provider
dataProvider.Apply();
}
}
using UnityEditor;
using UnityEditor.U2D.Sprites;
using UnityEngine;
public static class MyCustomTool
{
[MenuItem("Custom/Update Sprite Settings")]
static void UpdateSettings()
{
foreach (var obj in Selection.objects)
{
if (obj is Texture2D)
{
var factory = new SpriteDataProviderFactories();
factory.Init();
var dataProvider = factory.GetSpriteEditorDataProviderFromObject(obj);
dataProvider.InitSpriteEditorDataProvider();
/* Use the data provider */
// Apply the changes made to the data provider
dataProvider.Apply();
// Reimport the asset to have the changes applied
var assetImporter = dataProvider.targetObject as AssetImporter;
assetImporter.SaveAndReimport();
}
}
}
}
static void AddSprite(ISpriteEditorDataProvider dataProvider)
{
// Define the new Sprite Rect
var newSprite = new SpriteRect()
{
name = "MyNewSprite",
spriteID = GUID.Generate(),
rect = new Rect(0, 0, 32, 32)
};
// Add the Sprite Rect to the list of existing Sprite Rects
var spriteRects = dataProvider.GetSpriteRects().ToList();
spriteRects.Add(newSprite);
// Write the updated data back to the data provider
dataProvider.SetSpriteRects(spriteRects.ToArray());
// Note: This section is only for Unity 2021.2 and newer
// Register the new Sprite Rect's name and GUID with the ISpriteNameFileIdDataProvider
var spriteNameFileIdDataProvider = dataProvider.GetDataProvider<ISpriteNameFileIdDataProvider>();
var nameFileIdPairs = spriteNameFileIdDataProvider.GetNameFileIdPairs().ToList();
nameFileIdPairs.Add(new SpriteNameFileIdPair(newSprite.name, newSprite.spriteID));
spriteNameFileIdDataProvider.SetNameFileIdPairs(nameFileIdPairs);
// End of Unity 2021.2 and newer section
// Apply the changes
dataProvider.Apply();
}
static void SetPivot(ISpriteEditorDataProvider dataProvider)
{
// Get all the existing Sprites
var spriteRects = dataProvider.GetSpriteRects();
// Loop over all Sprites and update the pivots
foreach (var rect in spriteRects)
{
rect.pivot = new Vector2(0.1f, 0.2f);
rect.alignment = SpriteAlignment.Custom;
}
// Write the updated data back to the data provider
dataProvider.SetSpriteRects(spriteRects);
// Apply the changes
dataProvider.Apply();
}
static void RemoveSprite(ISpriteEditorDataProvider dataProvider, string spriteName)
{
// Get all the existing Sprites and look for the Sprite with the selected name
var spriteRects = dataProvider.GetSpriteRects().ToList();
var index = spriteRects.FindIndex(x => x.name == spriteName);
// Remove the entry of the Sprite if found
if (index >= 0)
spriteRects.RemoveAt(index);
// Write the updated data back to the data provider
dataProvider.SetSpriteRects(spriteRects.ToArray());
// Note: This section is only for Unity 2021.2 and newer
// Get all the existing SpriteName & FileId pairs and look for the Sprite with the selected name
var spriteNameFileIdDataProvider = dataProvider.GetDataProvider<ISpriteNameFileIdDataProvider>();
var nameFileIdPairs = spriteNameFileIdDataProvider.GetNameFileIdPairs().ToList();
index = nameFileIdPairs.FindIndex(x => x.name == spriteName);
// Remove the entry of the Sprite if found
if (index >= 0)
nameFileIdPairs.RemoveAt(index);
spriteNameFileIdDataProvider.SetNameFileIdPairs(nameFileIdPairs);
// End of Unity 2021.2 and newer section
// Apply the changes
dataProvider.Apply();
}
static void SetOutline(ISpriteEditorDataProvider dataProvider)
{
// Get the ISpriteOutlineDataProvider
var outlineDataProvider = dataProvider.GetDataProvider<ISpriteOutlineDataProvider>();
// Loop over all Sprites and set their outline to a quad
var spriteRects = dataProvider.GetSpriteRects();
foreach (var spriteRect in spriteRects)
{
var halfWidth = spriteRect.rect.width / 2f;
var halfHeight = spriteRect.rect.height / 2f;
var quadOutline = new Vector2[4]
{
new Vector2(-halfWidth, -halfHeight),
new Vector2(-halfWidth, halfHeight),
new Vector2(halfWidth, halfHeight),
new Vector2(halfWidth, -halfHeight)
};
var outlines = new List<Vector2[]>();
outlines.Add(quadOutline);
var spriteGuid = spriteRect.spriteID;
outlineDataProvider.SetOutlines(spriteGuid, outlines);
}
// Apply the changes
dataProvider.Apply();
}
When you visit any website, it may store or retrieve information on your browser, mostly in the form of cookies. This information might be about you, your preferences or your device and is mostly used to make the site work as you expect it to. The information does not usually directly identify you, but it can give you a more personalized web experience. Because we respect your right to privacy, you can choose not to allow some types of cookies. Click on the different category headings to find out more and change our default settings. However, blocking some types of cookies may impact your experience of the site and the services we are able to offer.
More information
These cookies enable the website to provide enhanced functionality and personalisation. They may be set by us or by third party providers whose services we have added to our pages. If you do not allow these cookies then some or all of these services may not function properly.
These cookies allow us to count visits and traffic sources so we can measure and improve the performance of our site. They help us to know which pages are the most and least popular and see how visitors move around the site. All information these cookies collect is aggregated and therefore anonymous. If you do not allow these cookies we will not know when you have visited our site, and will not be able to monitor its performance.
These cookies may be set through our site by our advertising partners. They may be used by those companies to build a profile of your interests and show you relevant adverts on other sites. They do not store directly personal information, but are based on uniquely identifying your browser and internet device. If you do not allow these cookies, you will experience less targeted advertising. Some 3rd party video providers do not allow video views without targeting cookies. If you are experiencing difficulty viewing a video, you will need to set your cookie preferences for targeting to yes if you wish to view videos from these providers. Unity does not control this.
These cookies are necessary for the website to function and cannot be switched off in our systems. They are usually only set in response to actions made by you which amount to a request for services, such as setting your privacy preferences, logging in or filling in forms. You can set your browser to block or alert you about these cookies, but some parts of the site will not then work. These cookies do not store any personally identifiable information.