Use the Image element to add graphical assets to your application. It’s a versatile and powerful tool for displaying visual content in your UI(User Interface) Allows a user to interact with your application. Unity currently supports three UI systems. More info
See in Glossary, such as image galleries, product listings, a rendering preview, and user profiles.
You must use either UXML or C# code to add an Image element in your UI and provide the image source to the --unity-image
USS custom property.
You can set the image scale mode with the --unity-image-size
USS custom property. You can also set the image tint color with the --unity-image-tint-color
USS custom property.
The following UXML example uses an inline style to add an image source:
<ui:Image style="--unity-image: url('path/to/image');"/>
You can set the size and layout of the Image element, as well as the sizing and layout of the image within the element. This allows you to control how the image is displayed within your UI, such as resizing it to fit a particular area or aligning it with other UI elements. You can also add interactivity to the Image element, such as allowing the user to click or tap on the image to trigger an action. You can apply styles to the Image element and the image itself, such as adjusting the opacity or applying a color filter.
VisualElement.style.backgroundImage
You can use both the Image element and the VisualElement.style.backgroundImage
property to add visual content to your UI. The choice between the two depends on the specific usage and requirements of your application.
The Image element is typically used to display an image within a specific area of a UI, such as an image gallery or an avatarAn interface for retargeting animation from one rig to another. More info
See in Glossary in a user profile. It provides more fine-grained control over the appearance of the image, including options for resizing, scaling, and cropping. Use Image when you want the size of an image to drive the size of an element in the layout. You can also add additional elements to the Image element to create overlays or add interactivity. However, for performance reasons, specify a fixed width and height if you use many instances of Image.
The VisualElement.style.backgroundImage
property is used to set an image as the background of a UI element. This is useful when you want to add visual interest to an element without detracting from the main content or functionality of the UI. The VisualElement.style.backgroundImage
property also allows the convenience of using USS to change the source image for many different elements.
In general, it’s recommended to use the Image element when you need more control over the appearance and layout of an image; and to use the VisualElement.style.backgroundImage
property when you simply want to add a background image to a UI element. However, both approaches are valid and you can use them together in the same UI if necessary.
Note:
style.backgroundImage
property. The background image won’t be visible if the Image element has an image source set and it’s not transparent.VisualElement
class. You can style the look, define the behaviour, and display it on screen as part of the UI. More info
C# class: Image
Namespace: UnityEngine.UIElements
Base class: VisualElement
This element inherits the following attributes from its base class:
Name | Type | Description |
---|---|---|
focusable |
boolean |
True if the element can be focused. |
tabindex |
int |
An integer used to sort focusables in the focus ring. Must be greater than or equal to zero. |
This element also inherits the following attributes from VisualElement
:
Name | Type | Description |
---|---|---|
content-container |
string |
Child elements are added to it, usually this is the same as the element itself. |
data-source |
Object |
Assigns a data source to this VisualElement which overrides any inherited data source. This data source is inherited by all children. |
data-source-path |
string |
Path from the data source to the value. |
data-source-type |
System.Type |
The possible type of data source assignable to this VisualElement. This information is only used by the UI Builder as a hint to provide some completion to the data source path field when the effective data source cannot be specified at design time. |
language-direction |
UIElements.LanguageDirection |
Indicates the directionality of the element’s text. The value will propagate to the element’s children. Setting the languageDirection to RTL adds basic support for right-to-left (RTL) by reversing the text and handling linebreaking and word wrapping appropriately. However, it does not provide comprehensive RTL support, as this would require text shaping, which includes the reordering of characters, and OpenType font feature support. Comprehensive RTL support is planned for future updates, which will involve additional APIs to handle language, script, and font feature specifications. To enhance the RTL functionality of this property, users can explore available third-party plugins in the Unity Asset Store and make use of ITextElementExperimentalFeatures.renderedText
|
name |
string |
The name of this VisualElement. Use this property to write USS selectors that target a specific element. The standard practice is to give an element a unique name. |
picking-mode |
UIElements.PickingMode |
Determines if this element can be pick during mouseEvents or IPanel.Pick queries. |
style |
string |
Sets the VisualElement style values. |
tooltip |
string |
Text to display inside an information box after the user hovers the element for a small amount of time. This is only supported in the Editor UI. |
usage-hints |
UIElements.UsageHints |
A combination of hint values that specify high-level intended usage patterns for the VisualElement . This property can only be set when the VisualElement is not yet part of a Panel . Once part of a Panel , this property becomes effectively read-only, and attempts to change it will throw an exception. The specification of proper UsageHints drives the system to make better decisions on how to process or accelerate certain operations based on the anticipated usage pattern. Note that those hints do not affect behavioral or visual results, but only affect the overall performance of the panel and the elements within. It’s advised to always consider specifying the proper UsageHints , but keep in mind that some UsageHints might be internally ignored under certain conditions (e.g. due to hardware limitations on the target platform). |
view-data-key |
string |
Used for view data persistence, such as tree expanded states, scroll position, or zoom level. This key is used to save and load the view data from the view data store. If you don’t set this key, the persistence is disabled for the associated VisualElement . For more information, refer to View data persistence. |
The following table lists all the C# public property names and their related USS selector.
C# property | USS selector | Description |
---|---|---|
ussClassName |
.unity-image |
USS class name of elements of this type. |
disabledUssClassName |
.unity-disabled |
USS class name of local disabled elements. |
The following table outlines the custom properties that are available exclusively for the Image element in USS:
Property | Type | Description |
---|---|---|
--unity-image |
string | The source of the image file. For information on how to reference an image asset, refer to AssetsAny media or data that can be used in your game or project. An asset may come from a file created outside of Unity, such as a 3D Model, an audio file or an image. You can also create some asset types in Unity, such as an Animator Controller, an Audio Mixer or a Render Texture. More info See in Glossary. |
--unity-image-size |
string | The image scale mode. Available values are stretch-to-fill , scale-and-crop and scale-to-fit . |
--unity-image-tint-color |
string | The image tint color. |
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.