FormWren
Pre-release docs

Rounded Rectangle documentation

Compatibility

Check the Unity version, render pipeline, and required packages before importing Rounded Rectangle.

Compatibility status

Current Validation Targets

Unity 2022.3.62f3Built-in Render Pipeline

Current validation target.

Unity 2022.3.62f3URP

Current validation target.

Unity 6000.0.34f1Built-in Render Pipeline

Current validation target.

Unity 6000.0.34f1URP

Current validation target.

These targets are not yet verified support combinations. Use the final support table when it replaces this validation-target list.

Older Unity versions and HDRP are outside the intended matrix for this documentation.

On affected Unity 6 Windows Editor versions, D3D11 with Gamma colour space can cause Scene view flicker near gizmo hitboxes. The handles remain functional; see Scene View Flicker for workarounds.

Usually already installed

Check Unity UI In Minimal Projects

Most 2D, 3D, and URP templates already include Unity UI. Rounded Rectangle uses it for Canvas Mesh UI, Canvas SDF, buttons, runtime handles, cache controls, and several Editor workflows. In a minimal or custom project, confirm that com.unity.ugui is installed before importing.

  1. Open Window > Package Manager.
  2. Install or restore Unity UI using the version resolved for your Unity Editor generation.
  3. Let package resolution and script compilation finish before importing or reimporting Rounded Rectangle.

Missing UnityEngine.UI or UnityEngine.EventSystems types usually mean Unity UI is absent. Do not blindly copy another project's package lock.

Before choosing a material

Identify The Project Render Pipeline

  1. Open Edit > Project Settings > Graphics.
  2. Inspect the assigned Scriptable Render Pipeline settings.
  3. No assigned render-pipeline asset normally indicates Built-in; a Universal Render Pipeline asset indicates URP.
  4. Use shaders and materials intended for that pipeline.

After identifying the pipeline, use Core Package And Optional URP/XR Supplement to choose the import payload.

Core Package And Optional URP/XR Supplement

The core package contains pipeline-neutral runtime and Editor code plus Built-in-compatible materials. Import it in Built-in or URP projects.

The optional URP/XR supplement contains pipeline-specific World Mesh shader and material assets. Import it only after URP is already installed and configured. The supplement does not install URP, change project render-pipeline settings, or replace the core package.

If a Built-in project reports unresolved URP dependencies, remove the optional supplement or URP-only custom content, then reimport the core package.

In a core-only URP project, pipeline-specific Embossed World Mesh setup refuses rather than silently assigning a Built-in shader.

Five-minute setup check

Five-Minute Smoke Test

  1. Record the exact Unity version and identify Built-in or URP.
  2. Confirm Unity UI (com.unity.ugui) is installed.
  3. Import the intended package payload; wait for compilation and inspect the Console.
  4. From Unity's main menu, create Tools > Rounded Rectangle > Create > Rounded Rectangle, frame it, and change radius and fill.
  5. On a separate object, use the same main menu and choose Tools > Rounded Rectangle > Rendering Path > Move Selected to Canvas SDF; confirm a visible Canvas result.
  6. Enter Play Mode and confirm both results again.

Cache, mask, export, runtime handles, and player builds require their own checks after this base import smoke test passes.

First Player Build Shader Compilation

The first player build for a graphics API may spend longer compiling and caching SDF shader variants. Check the Editor log before treating the build as stuck. Later builds can reuse Unity's Library/ShaderCache; deleting Library or changing the graphics API or shader-keyword set can require compilation again. The time varies by Editor version, hardware, graphics API, and build target.

TextMesh Pro

TextMesh Pro is not a package dependency. The rounded-rectangle renderer does not require TMP, and the shipped example scenes use Unity's built-in UI text. If TMP is already installed, Rounded Rectangle visuals can be used beside it normally; no TMP Essential Resources import is required for the shipped package examples.

Missing References After Import

  1. Capture the first Console error before changing assets.
  2. Confirm the project pipeline matches the imported shader/material content.
  3. Reimport only after the dependency or pipeline mismatch is understood.
  4. When reporting the issue, include Unity version, pipeline, package version, first error, and the smallest affected object or scene.

For visible symptoms continue to Troubleshooting.