When using USS, you can specify values for built-in VisualElement
properties or for custom properties in your UI(User Interface) Allows a user to interact with your application. Unity currently supports three UI systems. More info
See in Glossary code.
In addition of reading their values from USS files, you can assign built-in property values in C#, using the C# properties of VisualElement
. Values assigned in C# override values from a Unity style sheet (USS).
You can extend USS with custom properties. Custom USS Properties require the --
prefix.
This section lists the supported types.
UI Toolkit supports pixelsThe smallest unit in a computer image. Pixel size depends on your screen resolution. Pixel lighting is calculated at every screen pixel. More info
See in Glossary (px
) and percentages (%
) as units of measurement for length. Pixel values are absolute, while percentages are usually relative to the element’s parent.
Examples:
width:200px;
expresses a width of 200 pixels.width:50%;
expresses a width of half of the parent element’s width.It’s important to specify the unit of measurement. If you do not specify a unit of measurement, UI Toolkit assumes that the property value is expressed in pixels.
Note: 0
is a special value that doesn’t require a unit of measurement.
Numeric values are expressed as either floating points or integer literals. For example, flex:1.0
.
Specific keywords are supported for some built-in properties. Keywords provide a descriptive name instead of a number. For example: position:absolute
. All properties support the initial
global keyword which resets a property to its default value. See supported properties for a list of keywords.
UI Toolkit supports the following literal color values and functions:
#FFFF00
(rgba one byte per channel), #0F0
(rgb)rgb(255, 255, 0)
rgba(255, 255, 0, 1.0)
blue
, transparent
You can reference project assets such as fonts and textures from your USS files. For example, you might reference a texture to use as the background image for an element.
To reference an asset, you can use either the url()
function or the resource()
function. Referenced Assets are resolved when the style sheet is imported.
For example, the style declaration below uses the resource()
function to reference a texture asset named img.png
in the Images
directory, and specify it as the background image.
`background-image: resource("Images/img.png");
Unity recommends using url()
function in most cases. However, the resource()
function supports automatically loading different versions of image assets for different screen densities.
When you reference an asset with the url()
function, the path you specify can be relative or absolute:
The path must include the file extension.
For example, let’s say your project has a USS
folder that contains all of your style sheets, and a Resources folder that contains all of your image assets.
Assets
└─ Editor
└─ Resources
└─ USS
To reference an image named thumb.png
, you can use one of the following paths:
Relative path | Absolute path |
---|---|
url("../Resources/thumb.png") |
url("/Assets/Editor/Resources/thumb.png") url("project:/Assets/Editor/Resources/thumb.png") url("project:///Assets/Editor/Resources/thumb.png")
|
The resource()
function can reference assets in Unity’s resource folders (Resources
and Editor Default Resources
). You reference an asset by name.
Editor Default Resources Resources
folder, you must include the file extension.Resources
folder, you must not include the file extension.For example:
Path to file | Reference syntax |
---|---|
Assets/Resources/Images/my-image.png |
resource("Images/my-image") |
Assets/Editor Default Resources/Images/my-image.png |
resource("Images/default-image.png") |
If you need to support screens with different screen densities (DPI), the resource()
function allows you to load the correct versions of texture assets automatically.
You have to:
@2x
suffix in their file names. For example the high DPI version of myimage.png
should be myimage@2x.png
When Unity loads the asset, it automatically chooses the correct version for the current screen DPI.
For example, if you use resource("myimage")
in USS, Unity loads either Resources/myimage.png
or Resources/myimage@2x.png
.
Use quotes to specify a string value. For example: --my-property: "foo"
.
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.