Painter2D

Description

Object to draw 2D vector graphics.

The example below demonstrates how to use the Painter2D class to draw content in a VisualElement with the VisualElement.generateVisualContent callback.

You can also create a standalone Painter2D.Painter2D object to draw content offscreen, and use the Painter2D.SaveToVectorImage method to save the painter content in a VectorImage asset.

 using UnityEngine;
 using UnityEngine.UIElements;

 [RequireComponent(typeof(UIDocument))]
 public class Painter2DExample : MonoBehaviour
 {
     public void OnEnable()
     {
         var doc = GetComponent<UIDocument>();
         doc.rootVisualElement.generateVisualContent += Draw;
     }

     void Draw(MeshGenerationContext ctx)
     {
         var painter = ctx.painter2D;
         painter.lineWidth = 10.0f;
         painter.lineCap = LineCap.Round;
         painter.strokeGradient = new Gradient() {
             colorKeys = new GradientColorKey[] {
                 new GradientColorKey() { color = Color.red, time = 0.0f },
                 new GradientColorKey() { color = Color.blue, time = 1.0f }
             }
         };
         painter.BeginPath();
         painter.MoveTo(new Vector2(10, 10));
         painter.BezierCurveTo(new Vector2(100, 100), new Vector2(200, 0), new Vector2(300, 100));
         painter.Stroke();
     }
 }

Properties

Constructors

Public Methods