Is the package functional in Unity 6 with UI2.0

[TLabAltoh]

(I opened this issue but maybe each test and result needs to be separated as a sub-issue of #23 ?)

• Add component test

• Build test (Built in Render Pipeline)

---

⇧⇧⇧

Checked: Passed test or filled all checkbox of status secrion
Unchecked: Failure to meet the above conditions

[TLabAltoh]

Test 1: Add component test

Status

• Failed and needs to be fixed
• Fixed (Pushed to master branch)
• Pushed to upm branch

Step

• install unity6
• create empty project in unity editor as editor version 6000.* (currently, only 3D Built-in Render Pipeline. URP not tested yet ...).
• create folder name of Assets\TLab and clone this repo under it.
• add Canvas and add SDFQuad on the Canvas

Problem what I faced

Problem background

Unity6 seems add new pre-processor name of include_with_pragmas. In this package, ShaderSetup.hlsl contains #pragma and Unity6 ignores it when import hlsl file via #include. So maybe we need to use #include_with_pragma on Unity6.

As current measures ...

There are only 2 file witch uses pragma. So I want to switch code with pre-defined keyward that detect this project Unity6 or not in shader.

C:\{My Local Path}\Unity6-Investigation\Assets\TLab\Unity-SDF-UI-Toolkit>grep -r #pragma
Runtime/Resources/Shaders/SDF-UI/ShaderSetup.hlsl:#pragma vertex vert
Runtime/Resources/Shaders/SDF-UI/ShaderSetup.hlsl:#pragma fragment frag
Runtime/Resources/Shaders/SDF-UI/ShaderSetup.hlsl:#pragma multi_compile_local _ UNITY_UI_CLIP_RECT
Runtime/Resources/Shaders/SDF-UI/ShaderSetup.hlsl:#pragma multi_compile_local _ UNITY_UI_ALPHACLIP
Runtime/Resources/Shaders/SDF-UI/ShaderSetup.hlsl:#pragma multi_compile_local _ SDF_UI_AA
Runtime/Resources/Shaders/SDF-UI/ShaderSetup.hlsl:#pragma multi_compile_local _ SDF_UI_ONION
Runtime/Resources/Shaders/SDF-UI/ShaderSetup.hlsl:#pragma multi_compile_local _ SDF_UI_SHADOW_ENABLED
Runtime/Resources/Shaders/SDF-UI/Spline-ShaderSetup.hlsl:#pragma multi_compile_local _ SDF_UI_SPLINE_FILL

#include "Quad-Properties.hlsl"
#include "SDFUtils.cginc"

#if UNITY_6*
#include_with_pragma "ShaderSetup.hlsl"
#else
#include "ShaderSetup.hlsl"
#endif

For now, I'm checking to see if there's an official way to determine if the shader is Unity6 or not in the shader.

[TLabAltoh]

I did some research and maybe it seems there is no feature for conditional compilation in shaders. So maybe it seems need to add shader keyward for switch hlsl import process.

internal const string KEYWORD_UNITY_6 = SHADER_KEYWORD_PREFIX + "UNITY_6";

// SDFUI.cs
protected virtual void UpdateMaterialRecord() {

                        ...

#if UNITY_6000_0_OR_NEWER
			_materialRecord.SetKeywordActive(KEYWORD_UNITY_6, true);
#else
			_materialRecord.SetKeywordActive(KEYWORD_UNITY_6, false);
#endif


                        ...

}

[TLabAltoh]

I did some research and maybe it seems there is no feature for conditional compilation in shaders. So maybe it seems need to add shader keyward for switch hlsl import process.

internal const string KEYWORD_UNITY_6 = SHADER_KEYWORD_PREFIX + "UNITY_6";

// SDFUI.cs
protected virtual void UpdateMaterialRecord() {

                    ...

#if UNITY_6000_0_OR_NEWER
_materialRecord.SetKeywordActive(KEYWORD_UNITY_6, true);
#else
_materialRecord.SetKeywordActive(KEYWORD_UNITY_6, false);
#endif

                    ...

}

I decided not to, because adding keywords increases the size of the build app. So I think I will copy the keywords directly from the hlsl file to the each shader file's CGPROGRAM block.

[TLabAltoh]

At the moment more research needs to be done on the Unity6 compatibility of this plugin. But this update should not affect the current environment. So I published it as temporary measures. #23

[TLabAltoh]

Test2: Build test (only Built in Render Pipeline)

Status

• Failed and needs to be fixed
• Fixed (Pushed to master branch)
• Pushed to upm branch

Step

Build and run

Result

Problem background

In the recebt update, I added roundness property to SDFPie and it causes error.

#if UNITY_EDITOR
using UnityEngine;
using UnityEditor;
#endif

namespace TLab.UI.SDF
{
	public class SDFPie : SDFCircleBased
	{
		[SerializeField, Range(0, 1)] private float m_roundness = 0.1f;  // SerializeField needs namespace 'UnityEngine'

		public float roundness
		{
			get => m_roundness;
			set
			{
				if (m_roundness != value)
				{
					m_roundness = value;

					SetAllDirty();
				}
			}
		}
}

After build error fixed

Windows

video.1.mp4

WebGL

video.0.mp4

SDFSpline doesn't supported on WebGL platform (because StructuredBuffer doesn't supported on WebGL). So it's a concern, but it's working as intended.