Merge pull request #2102 from ousttrue/doc/urp_document

[doc] urp 関連
vrm-c · Jul 7, 2023 · 3624a25 · 3624a25
2 parents 904ce47 + 3de12d8
commit 3624a25
Show file tree

Hide file tree

Showing 4 changed files with 98 additions and 34 deletions.
diff --git a/docs/api/0_112_urp.md b/docs/api/0_112_urp.md
@@ -0,0 +1,46 @@
+# `v0.112` MToon の URP 対応
+
+| URP-Shader |                 |
+|------------|-----------------|
+| Standard   | ✅               |
+| Unlit      | ✅               |
+| MToon      | ✅ `from v0.112` |
+
+## `v0.112` URP サポート状況
+
+|                | URP | HDRP |
+|----------------|-----|------|
+| Runtime Import | ✅   | No   |
+| Editor Import  | WIP | No   |
+| Runtime Export | WIP | No   |
+| Editor Export  | WIP | No   |
+
+* `Urpオプションを有効にして` VRM-1.0 を Runtime ロードした時に、にマテリアルが `URP版` に入れ替わります。
+
+:::{note}
+VRM-0.x モデルでも import 時に migrate して VRM-1.0 として運用することが可能です
+
+[RuntimeLoad](/vrm1/vrm1_load)
+:::
+
+:::{warning}
+VRM-0.x 版の URP MToon 提供の予定はありません。
+:::
+
+:::{warning}
+URP MToon をエクスポートする機能はまだありません。
+
+URP のプロジェクトでセットアップした VRM をエクスポートしても、
+Material 情報を反映するの機能が未実装です。
+:::
+
+## 利用方法
+
+サンプル `Assets\VRM10_Samples\URPSample` を参照してください。
+
+![project_settings](https://github.com/vrm-c/UniVRM/assets/68057/b89d1b5b-251b-4ee7-b17d-9dfbd5bac81a)
+
+## ビルド
+
+URP Shader をビルドに含める必要があります。
+[ビルド](/build) を参照してください。
diff --git a/docs/api/index.md b/docs/api/index.md
@@ -15,6 +15,7 @@ firstperson
 0_58_blendshape
 how_to_impl_extension
 0_68_runtime_import
+0_76_texture_deserializer
 0_77_runtime_import
 0_79_runtime_import
 0_82_glb_import
@@ -26,5 +27,5 @@ fast_spring_bone
 0_95_highlevel
 0_96_1_use_gamma_colorspace
 0_106_spring_manual_update
-0_76_texture_deserializer
+0_112_urp
 ```
diff --git a/docs/build.md b/docs/build.md
@@ -6,7 +6,31 @@ UniVRMを使うアプリケーションのビルドに関する注意事項
 
 `Project Settings = Graphics - Always Included Shaders` などに設定して、以下のシェーダーがビルドに含まれるようにしてください。
 
-### Standard
+### URP
+
+#### Standard
+
+* `Universal Render Pipeline/Lit`
+
+#### Unlit
+
+* `Assets\VRMShaders\GLTF\UniUnlit\Resources\UniGLTF\UniUnlit.shader`
+
+```{admonition} Always Included Shaders
+`Resources` に配置しているので明示的に指定しなくてもビルドに含まれます。
+```
+
+#### MToon
+
+* `Assets/VRMShaders/VRM10/MToon10/Resources/VRM10/vrmc_materials_mtoon_urp.shader`
+
+```{admonition} Always Included Shaders
+`Resources` に配置しているので明示的に指定しなくてもビルドに含まれます。
+```
+
+### builtin
+
+#### Standard
 
 * `Standard`
 
@@ -17,23 +41,29 @@ GLTF の PBR マテリアルが使用します。
 明示的に指定する必要があります
 ```
 
-### Unlit
+#### Unlit
 
 * `Assets\VRMShaders\GLTF\UniUnlit\Resources\UniGLTF\UniUnlit.shader`
 
 ```{admonition} Always Included Shaders
 `Resources` に配置しているので明示的に指定しなくてもビルドに含まれます。
 ```
 
-### MToon
+#### MToon
 
 * `Assets\VRMShaders\VRM\MToon\MToon\Resources\Shaders\MToon.shader`
 
 ```{admonition} Always Included Shaders
 `Resources` に配置しているので明示的に指定しなくてもビルドに含まれます。
 ```
 
-### ランタイム import/export 時のテクスチャー変換用のシェーダー
+## テクスチャー変換用のシェーダー
+
+import/export 時に使用します。
+
+:::{note}
+ビルトイン/URP の両方で使われます
+:::
 
 * `Assets\VRMShaders\GLTF\IO\Resources\UniGLTF\NormalMapExporter.shader`
 * `Assets\VRMShaders\GLTF\IO\Resources\UniGLTF\StandardMapExporter.shader`
@@ -42,3 +72,18 @@ GLTF の PBR マテリアルが使用します。
 ```{admonition} Always Included Shaders
 `Resources` に配置しているので明示的に指定しなくてもビルドに含まれます。
 ```
+
+## URP package が必要です
+
+未インストールの場合は PackageManager から URP package をインストールしてください
+
+<img height=300 src=https://github.com/vrm-c/UniVRM/assets/68057/a48816d7-7db2-469e-b762-a0951fa8a670>
+
+**エラーメッセージ**
+
+<details>
+Shader error in 'VRM10/Universal Render Pipeline/MToon10': Couldn't open include file 'Packages/com.unity.render-pipelines.universal/ShaderLibrary/Core.hlsl'. at /ghq/github.com/ousttrue/UniVRM-UPM/Library/PackageCache/com.vrmc.vrmshaders@b4130b9e5d/VRM10/MToon10/Resources/VRM10/vrmc_materials_mtoon_render_pipeline.hlsl(5)
+Compiling Subshader: 0, Pass: UniversalForward, Vertex program with DIRECTIONAL
+Platform defines: SHADER_API_DESKTOP UNITY_ENABLE_DETAIL_NORMALMAP UNITY_ENABLE_REFLECTION_BUFFERS UNITY_LIGHTMAP_FULL_HDR UNITY_LIGHT_PROBE_PROXY_VOLUME UNITY_PBS_USE_BRDF1 UNITY_SPECCUBE_BLENDING UNITY_SPECCUBE_BOX_PROJECTION UNITY_USE_DITHER_MASK_FOR_ALPHABLENDED_SHADOWS
+Disabled keywords: FOG_EXP FOG_EXP2 FOG_LINEAR INSTANCING_ON LIGHTMAP_SHADOW_MIXING LIGHTPROBE_SH SHADER_API_GLES30 SHADOWS_SCREEN SHADOWS_SHADOWMASK UNITY_ASTC_NORMALMAP_ENCODING UNITY_COLORSPACE_GAMMA UNITY_ENABLE_NATIVE_SHADOW_LOOKUPS UNITY_FRAMEBUFFER_FETCH_AVAILABLE UNITY_HALF_PRECISION_FRAGMENT_SHADER_REGISTERS UNITY_HARDWARE_TIER1 UNITY_HARDWARE_TIER2 UNITY_HARDWARE_TIER3 UNITY_LIGHTMAP_DLDR_ENCODING UNITY_LIGHTMAP_RGBM_ENCODING UNITY_METAL_SHADOWS_USE_POINT_FILTERING UNITY_NO_DXT5nm UNITY_NO_FULL_STANDARD_SHADER UNITY_NO_SCREENSPACE_SHADOWS UNITY_PBS_USE_BRDF2 UNITY_PBS_USE_BRDF3 UNITY_PRETRANSFORM_TO_DISPLAY_ORIENTATION UNITY_UNIFIED_SHADER_PRECISION_MODEL UNITY_VIRTUAL_TEXTURING _ADDITIONAL_LIGHTS _ADDITIONAL_LIGHTS_VERTEX _ALPHABLEND_ON _ALPHATEST_ON _MAIN_LIGHT_SHADOWS _MAIN_LIGHT_SHADOWS_CASCADE _MTOON_EMISSIVEMAP _MTOON_PARAMETERMAP _MTOON_RIMMAP _NORMALMAP
+</details>
diff --git a/docs/release/112/v0.112.0.md b/docs/release/112/v0.112.0.md
@@ -8,33 +8,5 @@
 
 ## URP MToon (vrm-1.0向け) が利用可能になりました
 
-* アプリケーションで Runtime に利用可能です
-  * VRM-0.x モデルでも import 時に migrate して VRM-1.0 として運用することで URP 適用が可能です
-  * VRM-0.x 版の URP MToon 提供の予定はありません
-* **URP MToon をエクスポートする機能はまだありません**
+[URP](/api/0_112_urp)
 
-利用方法は、サンプル `Assets\VRM10_Samples\URPSample` を参照してください。
-
-![project_settings](https://github.com/vrm-c/UniVRM/assets/68057/b89d1b5b-251b-4ee7-b17d-9dfbd5bac81a)
-
-|| Built-in RP | URP | HDRP |
-|--|--|--|--|
-| Runtime Import |✅|✅|No|
-| Editor Import |✅|WIP|No|
-| Runtime Export |✅|WIP|No|
-| Editor Export |✅|WIP|No|
-
-### URP package が必要です
-
-未インストールの場合は PackageManager から URP package をインストールしてください
-
-<img height=300 src=https://github.com/vrm-c/UniVRM/assets/68057/a48816d7-7db2-469e-b762-a0951fa8a670>
-
-**エラーメッセージ**
-
-<details>
-Shader error in 'VRM10/Universal Render Pipeline/MToon10': Couldn't open include file 'Packages/com.unity.render-pipelines.universal/ShaderLibrary/Core.hlsl'. at /ghq/github.com/ousttrue/UniVRM-UPM/Library/PackageCache/com.vrmc.vrmshaders@b4130b9e5d/VRM10/MToon10/Resources/VRM10/vrmc_materials_mtoon_render_pipeline.hlsl(5)
-Compiling Subshader: 0, Pass: UniversalForward, Vertex program with DIRECTIONAL
-Platform defines: SHADER_API_DESKTOP UNITY_ENABLE_DETAIL_NORMALMAP UNITY_ENABLE_REFLECTION_BUFFERS UNITY_LIGHTMAP_FULL_HDR UNITY_LIGHT_PROBE_PROXY_VOLUME UNITY_PBS_USE_BRDF1 UNITY_SPECCUBE_BLENDING UNITY_SPECCUBE_BOX_PROJECTION UNITY_USE_DITHER_MASK_FOR_ALPHABLENDED_SHADOWS
-Disabled keywords: FOG_EXP FOG_EXP2 FOG_LINEAR INSTANCING_ON LIGHTMAP_SHADOW_MIXING LIGHTPROBE_SH SHADER_API_GLES30 SHADOWS_SCREEN SHADOWS_SHADOWMASK UNITY_ASTC_NORMALMAP_ENCODING UNITY_COLORSPACE_GAMMA UNITY_ENABLE_NATIVE_SHADOW_LOOKUPS UNITY_FRAMEBUFFER_FETCH_AVAILABLE UNITY_HALF_PRECISION_FRAGMENT_SHADER_REGISTERS UNITY_HARDWARE_TIER1 UNITY_HARDWARE_TIER2 UNITY_HARDWARE_TIER3 UNITY_LIGHTMAP_DLDR_ENCODING UNITY_LIGHTMAP_RGBM_ENCODING UNITY_METAL_SHADOWS_USE_POINT_FILTERING UNITY_NO_DXT5nm UNITY_NO_FULL_STANDARD_SHADER UNITY_NO_SCREENSPACE_SHADOWS UNITY_PBS_USE_BRDF2 UNITY_PBS_USE_BRDF3 UNITY_PRETRANSFORM_TO_DISPLAY_ORIENTATION UNITY_UNIFIED_SHADER_PRECISION_MODEL UNITY_VIRTUAL_TEXTURING _ADDITIONAL_LIGHTS _ADDITIONAL_LIGHTS_VERTEX _ALPHABLEND_ON _ALPHATEST_ON _MAIN_LIGHT_SHADOWS _MAIN_LIGHT_SHADOWS_CASCADE _MTOON_EMISSIVEMAP _MTOON_PARAMETERMAP _MTOON_RIMMAP _NORMALMAP
-</details>