Version: Unity 6.7 Alpha (6000.7)
LanguageEnglish
  • C#

Background

struct in UnityEngine.UIElements

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Description

Describes a VisualElement background.

Properties

Property Description
gradient The color gradient to display as a background, mutually exclusive with the asset slots. Setting an empty gradient (see BackgroundGradient.IsEmpty) clears the slot without disturbing any assigned asset.
renderTexture The RenderTexture to display as a background.
sprite The sprite to display as a background.
texture The texture to display as a background.
vectorImage The VectorImage to display as a background.

Public Methods

Method Description
GetSelectedImage Retrieves the selected asset which can be of a type of Texture, Sprite, RenderTexture or VectorImage.
IsEmpty Help verify whether an asset or gradient has been assigned or not.

Static Methods

Method Description
FromGradient Creates a background from a BackgroundGradient.
FromRenderTexture Creates a background from a RenderTexture.
FromSprite Creates a background from a Sprite.
FromTexture2D Creates a background from a Texture2D.
FromVectorImage Creates a background from a VectorImage.