Class SVGImage

A UI image that holds SVG content.

Inheritance

object

Object

Component

Behaviour

MonoBehaviour

UIBehaviour

Graphic

MaskableGraphic

SVGImage

Implements

ICanvasElement

IClippable

IMaskable

IMaterialModifier

Inherited Members

MaskableGraphic.m_ShouldRecalculateStencil

MaskableGraphic.m_MaskMaterial

MaskableGraphic.onCullStateChanged

MaskableGraphic.maskable

MaskableGraphic.isMaskingGraphic

MaskableGraphic.m_StencilValue

MaskableGraphic.GetModifiedMaterial(Material)

MaskableGraphic.Cull(Rect, bool)

MaskableGraphic.SetClipRect(Rect, bool)

MaskableGraphic.SetClipSoftness(Vector2)

MaskableGraphic.OnEnable()

MaskableGraphic.OnDisable()

MaskableGraphic.OnValidate()

MaskableGraphic.OnTransformParentChanged()

MaskableGraphic.OnCanvasHierarchyChanged()

MaskableGraphic.RecalculateClipping()

MaskableGraphic.RecalculateMasking()

Graphic.s_DefaultUI

Graphic.s_WhiteTexture

Graphic.defaultGraphicMaterial

Graphic.m_Material

Graphic.m_SkipLayoutUpdate

Graphic.m_SkipMaterialUpdate

Graphic.color

Graphic.raycastTarget

Graphic.m_OnDirtyLayoutCallback

Graphic.m_OnDirtyVertsCallback

Graphic.m_OnDirtyMaterialCallback

Graphic.s_Mesh

Graphic.m_CachedMesh

Graphic.m_CachedUvs

Graphic.useLegacyMeshGeneration

Graphic.SetAllDirty()

Graphic.SetLayoutDirty()

Graphic.SetVerticesDirty()

Graphic.SetMaterialDirty()

Graphic.OnRectTransformDimensionsChange()

Graphic.OnBeforeTransformParentChanged()

Graphic.depth

Graphic.rectTransform

Graphic.canvas

Graphic.canvasRenderer

Graphic.defaultMaterial

Graphic.material

Graphic.materialForRendering

Graphic.OnDestroy()

Graphic.OnCullingChanged()

Graphic.Rebuild(CanvasUpdate)

Graphic.LayoutComplete()

Graphic.GraphicUpdateComplete()

Graphic.UpdateMaterial()

Graphic.UpdateGeometry()

Graphic.workerMesh

Graphic.OnPopulateMesh(Mesh)

Graphic.OnRebuildRequested()

Graphic.Reset()

Graphic.OnDidApplyAnimationProperties()

Graphic.SetNativeSize()

Graphic.Raycast(Vector2, Camera)

Graphic.PixelAdjustPoint(Vector2)

Graphic.GetPixelAdjustedRect()

Graphic.CrossFadeColor(Color, float, bool, bool)

Graphic.CrossFadeColor(Color, float, bool, bool, bool)

Graphic.CrossFadeAlpha(float, float, bool)

Graphic.RegisterDirtyLayoutCallback(UnityAction)

Graphic.UnregisterDirtyLayoutCallback(UnityAction)

Graphic.RegisterDirtyVerticesCallback(UnityAction)

Graphic.UnregisterDirtyVerticesCallback(UnityAction)

Graphic.RegisterDirtyMaterialCallback(UnityAction)

Graphic.UnregisterDirtyMaterialCallback(UnityAction)

UIBehaviour.Awake()

UIBehaviour.Start()

UIBehaviour.IsActive()

UIBehaviour.OnCanvasGroupChanged()

UIBehaviour.IsDestroyed()

MonoBehaviour.IsInvoking()

MonoBehaviour.CancelInvoke()

MonoBehaviour.Invoke(string, float)

MonoBehaviour.InvokeRepeating(string, float, float)

MonoBehaviour.CancelInvoke(string)

MonoBehaviour.IsInvoking(string)

MonoBehaviour.StartCoroutine(string)

MonoBehaviour.StartCoroutine(string, object)

MonoBehaviour.StartCoroutine(IEnumerator)

MonoBehaviour.StartCoroutine_Auto(IEnumerator)

MonoBehaviour.StopCoroutine(IEnumerator)

MonoBehaviour.StopCoroutine(Coroutine)

MonoBehaviour.StopCoroutine(string)

MonoBehaviour.StopAllCoroutines()

MonoBehaviour.print(object)

MonoBehaviour.useGUILayout

MonoBehaviour.runInEditMode

Behaviour.enabled

Behaviour.isActiveAndEnabled

Component.GetComponent(Type)

Component.GetComponent<T>()

Component.TryGetComponent(Type, out Component)

Component.TryGetComponent<T>(out T)

Component.GetComponent(string)

Component.GetComponentInChildren(Type, bool)

Component.GetComponentInChildren(Type)

Component.GetComponentInChildren<T>(bool)

Component.GetComponentInChildren<T>()

Component.GetComponentsInChildren(Type, bool)

Component.GetComponentsInChildren(Type)

Component.GetComponentsInChildren<T>(bool)

Component.GetComponentsInChildren<T>(bool, List<T>)

Component.GetComponentsInChildren<T>()

Component.GetComponentsInChildren<T>(List<T>)

Component.GetComponentInParent(Type)

Component.GetComponentInParent<T>()

Component.GetComponentsInParent(Type, bool)

Component.GetComponentsInParent(Type)

Component.GetComponentsInParent<T>(bool)

Component.GetComponentsInParent<T>(bool, List<T>)

Component.GetComponentsInParent<T>()

Component.GetComponents(Type)

Component.GetComponents(Type, List<Component>)

Component.GetComponents<T>(List<T>)

Component.GetComponents<T>()

Component.CompareTag(string)

Component.SendMessageUpwards(string, object, SendMessageOptions)

Component.SendMessageUpwards(string, object)

Component.SendMessageUpwards(string)

Component.SendMessageUpwards(string, SendMessageOptions)

Component.SendMessage(string, object)

Component.SendMessage(string)

Component.SendMessage(string, object, SendMessageOptions)

Component.SendMessage(string, SendMessageOptions)

Component.BroadcastMessage(string, object, SendMessageOptions)

Component.BroadcastMessage(string, object)

Component.BroadcastMessage(string)

Component.BroadcastMessage(string, SendMessageOptions)

Component.transform

Component.gameObject

Component.tag

Object.GetInstanceID()

Object.GetHashCode()

Object.Equals(object)

Object.Instantiate(Object, Vector3, Quaternion)

Object.Instantiate(Object, Vector3, Quaternion, Transform)

Object.Instantiate(Object)

Object.Instantiate(Object, Transform)

Object.Instantiate(Object, Transform, bool)

Object.Instantiate<T>(T)

Object.Instantiate<T>(T, Vector3, Quaternion)

Object.Instantiate<T>(T, Vector3, Quaternion, Transform)

Object.Instantiate<T>(T, Transform)

Object.Instantiate<T>(T, Transform, bool)

Object.Destroy(Object, float)

Object.Destroy(Object)

Object.DestroyImmediate(Object, bool)

Object.DestroyImmediate(Object)

Object.FindObjectsOfType(Type)

Object.DontDestroyOnLoad(Object)

Object.DestroyObject(Object, float)

Object.DestroyObject(Object)

Object.FindSceneObjectsOfType(Type)

Object.FindObjectsOfTypeIncludingAssets(Type)

Object.FindObjectsOfType<T>()

Object.FindObjectOfType<T>()

Object.FindObjectsOfTypeAll(Type)

Object.FindObjectOfType(Type)

Object.ToString()

Object.name

Object.hideFlags

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Namespace: Unity.VectorGraphics

Assembly: Unity.VectorGraphics.dll

Syntax

[AddComponentMenu("UI/SVG Image", 11)]
[MovedFrom("")]
[RequireComponent(typeof(CanvasRenderer))]
public class SVGImage : MaskableGraphic, ICanvasElement, IClippable, IMaskable, IMaterialModifier

Properties

mainTexture

The main texture of the SVG image. This will be a white texture for textureless images.

Declaration

public override Texture mainTexture { get; }

Property Value

Type	Description
Texture

Overrides

UnityEngine.UI.Graphic.mainTexture

preserveAspect

If true, preserves the aspect ratio of the SVG image.

Declaration

public bool preserveAspect { get; set; }

Property Value

Type	Description
bool

sprite

The sprite that is used to render this image.

Declaration

public Sprite sprite { get; set; }

Property Value

Type	Description
Sprite

Remarks

This returns the source Sprite of an Image. This Sprite can also be viewed and changed in the Inspector as part of an Image component. This can also be used to change the Sprite using a script.

Methods

OnPopulateMesh(VertexHelper)

Populates the mesh

Declaration

protected override void OnPopulateMesh(VertexHelper toFill)

Parameters

Type	Name	Description
VertexHelper	toFill	The vertices to fill

Overrides

UnityEngine.UI.Graphic.OnPopulateMesh(UnityEngine.UI.VertexHelper)

Implements

UnityEngine.UI.ICanvasElement

UnityEngine.UI.IClippable

UnityEngine.UI.IMaskable

UnityEngine.UI.IMaterialModifier