You can use either the Image element or the VisualElement.style.backgroundImage
property to add visual content to your UI(User Interface) Allows a user to interact with your application. Unity currently supports three UI systems. More info
See in Glossary. The choice between the two depends on the specific requirements of your application. For more information, refer to Image versus VisualElement.style.backgroundImage
.
You can use an imported or built-in image asset to set a background image. When you set the background image, you must select a supported background image type:
Note:
com.unity.vectorgraphics
package.You can set the background image in UI Builder, directly in USS, or in C# files.
USS example:
MyElement { background-image: url("path/to/imageFile.png"); }
C# example:
// Use the AssetDatabase method to load the texture. myElement1.style.backgroundImage = AssetDatabase.LoadAssetAtPath<Texture2D>("path/to/imageFile.png"); // Use the AssetDatabase method to load the sprite. myElement2.style.backgroundImage = new StyleBackground(AssetDatabase.LoadAssetAtPath<Sprite>("path/to/spriteAssetFile.png")); // Load the texture from the project's Resources folder. myElement3.style.backgroundImage = Resources.Load<Texture2D>("imageFile"); // Load the sprite from the project's Resources folder. myElement4.style.backgroundImage = new StyleBackground(Resources.Load<Sprite>("spriteAssetFile")); // Use the Unity Editor's default resources. myElement5.style.backgroundImage = EditorGUIUtility.FindTexture("CloudConnect"); myElement6.style.backgroundImage = Background.FromTexture2D(EditorGUIUtility.IconContent("FolderOpened Icon").image as Texture2D);
Scale mode for a background image defines how the image scales to fit the visual elementA node of a visual tree that instantiates or derives from the C# VisualElement
class. You can style the look, define the behaviour, and display it on screen as part of the UI. More info
See in Glossary.
The supported scale modes for a background image.
A: stretch-to-fill
that stretches the image to fill the entire area of the visual element.
B: scale-and-crop
that scales the image to fit the visual element. If the image is larger than the visual element, the image is cropped.
C: scale-to-fit
that scales the image to fit the visual element. It’s similar to the stretch-to-fill mode, but the aspect ratioThe relationship of an image’s proportional dimensions, such as its width and height.
See in Glossary of the image is preserved.
You can set the scale mode in UI Builder, directly in USS, or in C# files.
USS example:
MyElement { -unity-background-scale-mode: scale-and-crop; }
C# example:
// Set the scale mode to scale-and-crop. myElement.style.backgroundPositionX = BackgroundPropertyHelper.ConvertScaleModeToBackgroundPosition(ScaleMode::ScaleAndCrop); myElement.style.backgroundPositionY = BackgroundPropertyHelper.ConvertScaleModeToBackgroundPosition(ScaleMode::ScaleAndCrop); myElement.style.backgroundRepeat = BackgroundPropertyHelper.ConvertScaleModeToBackgroundRepeat(ScaleMode::ScaleAndCrop); myElement.style.backgroundSize = BackgroundPropertyHelper.ConvertScaleModeToBackgroundSize(ScaleMode::ScaleAndCrop);
Generally, you can apply the 9-slice technique to a regular 2D Sprite. However, with UI Toolkit, you can apply the 9-slice technique to Texture, Render Texture, and SVG Vector images.
To apply 9-slice, set the following:
-unity-slice-scale
by the sprite’s pixels-per-unit
value in relation to the panel’s reference sprite pixels per unit value
, which is by default 100
. For example, if the sprite’s pixels-per-unit
is 16
, the scale is adjusted by 16/100 = 0.16
. Therefore, if you set the scale to 2px
, the final scale is 2px * 0.16px = 0.32px
. For texture and vector images, Unity doesn’t make additional adjustments to the slice scale value you set.You can set the slice values and slice scale with UI Builder, or directly in USS, or in C# files. For a sprite image, you can also set the values in the Sprite Editor.
UI Builder:
Use the Slice fields in the Background section to set the slice values and slice scale.
USS example:
MyElement { -unity-slice-left: 10px; -unity-slice-right: 10px; -unity-slice-top: 10px; -unity-slice-bottom: 10px; -unity-slice-scale: 2px; }
C# example:
MyElement.style.unitySliceLeft = 10px; MyElement.style.unitySliceRight = 10px; MyElement.style.unitySliceTop = 10px; MyElement.style.unitySliceBottom = 10px; MyElement.style.unitySliceScale = 2px;
Important:
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.
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.