CustomMaterial の作り方

ShaderGraph で TinyPbr を作成

v0.128.2 VRM10Viewer Sample にて PBR と MToon1.0 のカスタムシェーダーを提供予定です。

応急処置のため Sample に入れて正式サポート外としております。 PBR はそれなりに、MToon は簡易なものになります。

機能が不足する場合に改造や自作できるように、 ShaderGraph Shader 作成と Vrm10Importer へのカスタムの MaterialLoader 組み込み を説明します。

手順

Shader 関連の命名ガイドライン

シェーダーを中心に複数の関連ファイルを管理するので、一貫した命名にすると便利です。

TinyPbr と名付けた例。

type	name	note
shader	TinyPbr	TinyPbrOpaque, TinyPbrAlphaBlend, TinyPbrCutoff が必要かもしれない
補助クラス	TinyPbrContext.cs
IMaterialDescriptorGenerator	TinyPbrDescriptorGenerator.cs

ShaderGraph で Shader を作成

URP - Lit Shader Graph で作成しました。

TextureNode

最低限の動作確認をするために color texture だけを作成ます。

BaseColor に Sample Texture 2D を接続
Sample Texture 2D に Texture2D Asset を接続
Texture2D Asset を convert to property
Name BaseMap (TinyPbrMaterialContext.BaseMap と同じ)
check Use Tiling and Offsset
check Exposed

TextureProperty に MainTexture Flag

Importer に組込む

TinyPbrMaterialContext.cs

using UnityEngine;

namespace UniVRM10.VRM10Viewer
{
    public class TinyPbrContext
    {
        private static readonly int BaseMap = Shader.PropertyToID("_BaseMap");
        public readonly Material Material;

        public Texture BaseTexture
        {
            get => Material.GetTexture(BaseMap);
            set => Material.SetTexture(BaseMap, value);
        }

        public Vector2 BaseTextureOffset
        {
            get => Material.GetTextureOffset(BaseMap);
            set => Material.SetTextureOffset(BaseMap, value);
        }

        public Vector2 BaseTextureScale
        {
            get => Material.GetTextureScale(BaseMap);
            set => Material.SetTextureScale(BaseMap, value);
        }

        public TinyPbrContext(Material material)
        {
            Material = material;
        }
    }
}

TinyPbrDescriptorGenerator.cs

using System;
using System.Collections.Generic;
using System.Threading.Tasks;
using UniGLTF;
using UnityEngine;

namespace UniVRM10.VRM10Viewer
{
    /// <summary>
    /// GLTF の MaterialImporter
    /// </summary>
    public sealed class TinyPbrDescriptorGenerator : IMaterialDescriptorGenerator
    {
        public UrpGltfPbrMaterialImporter PbrMaterialImporter { get; } = new();
        public UrpGltfDefaultMaterialImporter DefaultMaterialImporter { get; } = new();

        public Material Material { get; set; }

        public TinyPbrDescriptorGenerator(Material material)
        {
            Material = material;
        }

        public MaterialDescriptor Get(GltfData data, int i)
        {
            // TODO: VRM

            // UNLIT
            MaterialDescriptor param;
            // if (BuiltInGltfUnlitMaterialImporter.TryCreateParam(data, i, out param)) return param;

            if (TryCreateParam(data, i, out param)) return param;

            // NOTE: Fallback to default material
            if (Symbols.VRM_DEVELOP)
            {
                Debug.LogWarning($"material: {i} out of range. fallback");
            }
            return GetGltfDefault(GltfMaterialImportUtils.ImportMaterialName(i, null));
        }

        public MaterialDescriptor GetGltfDefault(string materialName = null) => DefaultMaterialImporter.CreateParam(materialName);

        public bool TryCreateParam(GltfData data, int i, out MaterialDescriptor matDesc)
        {
            if (i < 0 || i >= data.GLTF.materials.Count)
            {
                matDesc = default;
                return false;
            }

            var src = data.GLTF.materials[i];
            matDesc = new MaterialDescriptor(
                GltfMaterialImportUtils.ImportMaterialName(i, src),
                Material.shader,
                null,
                new Dictionary<string, TextureDescriptor>(),
                new Dictionary<string, float>(),
                new Dictionary<string, Color>(),
                new Dictionary<string, Vector4>(),
                new List<Action<Material>>(),
                new[] { (MaterialDescriptor.MaterialGenerateAsyncFunc)AsyncAction }
            );
            return true;

            Task AsyncAction(Material x, GetTextureAsyncFunc y, IAwaitCaller z) => GenerateMaterialAsync(data, src, x, y, z);
        }

        public static async Task GenerateMaterialAsync(GltfData data, glTFMaterial src, Material dst, GetTextureAsyncFunc getTextureAsync, IAwaitCaller awaitCaller)
        {
            var context = new TinyPbrContext(dst);

            if (src is { pbrMetallicRoughness: { baseColorTexture: { index: >= 0 } } })
            {
                if (GltfPbrTextureImporter.TryBaseColorTexture(data, src, out _, out var desc))
                {
                    context.BaseTexture = await getTextureAsync(desc, awaitCaller);
                    context.BaseTextureOffset = desc.Offset;
                    context.BaseTextureScale = desc.Scale;
                }
            }
        }
    }
}

以下の部分が GltfData から ColorTexture を供給します。

        public static async Task GenerateMaterialAsync(GltfData data, glTFMaterial src, Material dst, GetTextureAsyncFunc getTextureAsync, IAwaitCaller awaitCaller)
        {
            var context = new TinyPbrContext(dst);

            if (src is { pbrMetallicRoughness: { baseColorTexture: { index: >= 0 } } })
            {
                if (GltfPbrTextureImporter.TryBaseColorTexture(data, src, out _, out var desc))
                {
                    context.BaseTexture = await getTextureAsync(desc, awaitCaller);
                    context.BaseTextureOffset = desc.Offset;
                    context.BaseTextureScale = desc.Scale;
                }
            }
        }

IMaterialDescriptorGenerator 詳細

TODO:

ShaderGraph で TinyPbr を作成​

手順​

Shader 関連の命名ガイドライン​

ShaderGraph で Shader を作成​

TextureNode​

Importer に組込む​

IMaterialDescriptorGenerator 詳細​