diff --git a/docs/gltf/0_36_update.md b/docs/api/0_36_update.md similarity index 96% rename from docs/gltf/0_36_update.md rename to docs/api/0_36_update.md index 3d6bdbf96..197c0d6a5 100644 --- a/docs/gltf/0_36_update.md +++ b/docs/api/0_36_update.md @@ -1,4 +1,4 @@ -# GltfUpdate(0.36) +# `v0.36` GltfUpdate ## テクスチャ名の格納位置の修正 diff --git a/docs/vrm0/0_44_runtime_import.md b/docs/api/0_44_runtime_import.md similarity index 99% rename from docs/vrm0/0_44_runtime_import.md rename to docs/api/0_44_runtime_import.md index 8df94639e..04a296561 100644 --- a/docs/vrm0/0_44_runtime_import.md +++ b/docs/api/0_44_runtime_import.md @@ -1,4 +1,4 @@ -# RuntimeImport(0.44) +# `v0.44` RuntimeImport ## `Version 0.44～` LoadAsyncの例 diff --git a/docs/vrm0/0_58_blendshape.md b/docs/api/0_58_blendshape.md similarity index 99% rename from docs/vrm0/0_58_blendshape.md rename to docs/api/0_58_blendshape.md index 52ccc735c..9b3eccb98 100644 --- a/docs/vrm0/0_58_blendshape.md +++ b/docs/api/0_58_blendshape.md @@ -1,4 +1,4 @@ -# BlendShapeProxy(0.58) +# `v0.58` BlendShapeProxy ## BlendShapeKeyのインタフェースを厳格化、整理 diff --git a/docs/vrm0/0_68_runtime_import.md b/docs/api/0_68_runtime_import.md similarity index 99% rename from docs/vrm0/0_68_runtime_import.md rename to docs/api/0_68_runtime_import.md index 44a2689ba..b007c6172 100644 --- a/docs/vrm0/0_68_runtime_import.md +++ b/docs/api/0_68_runtime_import.md @@ -1,4 +1,4 @@ -# RuntimeImport(0.68) DisposeOnGameObjectDestroyed(obsolete) +# `v0.68` RuntimeImport DisposeOnGameObjectDestroyed(obsolete) ## 過去バージョンからの仕様変更 diff --git a/docs/vrm0/0_77_runtime_import.md b/docs/api/0_77_runtime_import.md similarity index 98% rename from docs/vrm0/0_77_runtime_import.md rename to docs/api/0_77_runtime_import.md index 7b567b24a..fdf37ab85 100644 --- a/docs/vrm0/0_77_runtime_import.md +++ b/docs/api/0_77_runtime_import.md @@ -1,4 +1,4 @@ -# RuntimeImport(0.77) RuntimeGltfInstance +# `v0.77` RuntimeImport RuntimeGltfInstance [DisposeOnGameObjectDestroyed](https://github.com/vrm-c/UniVRM/issues/1018) diff --git a/docs/vrm0/0_79_runtime_import.md b/docs/api/0_79_runtime_import.md similarity index 83% rename from docs/vrm0/0_79_runtime_import.md rename to docs/api/0_79_runtime_import.md index 49fbc89bd..77f8da4f3 100644 --- a/docs/vrm0/0_79_runtime_import.md +++ b/docs/api/0_79_runtime_import.md @@ -1,4 +1,4 @@ -# RuntimeImport(0.79) GltfData +# `v0.79` RuntimeImport GltfData `GltfParser` と `GltfData` の分割 diff --git a/docs/gltf/0_82_glb_import.md b/docs/api/0_82_glb_import.md similarity index 98% rename from docs/gltf/0_82_glb_import.md rename to docs/api/0_82_glb_import.md index cab05c296..fa0f6de07 100644 --- a/docs/gltf/0_82_glb_import.md +++ b/docs/api/0_82_glb_import.md @@ -1,5 +1,4 @@ -# GlbImport(0.82) GltfData -from: `0.82.1` +# `v0.82.1` GlbImport GltfData 以下のステップでロードします。 diff --git a/docs/vrm0/0_82_runtime_import.md b/docs/api/0_82_runtime_import.md similarity index 97% rename from docs/vrm0/0_82_runtime_import.md rename to docs/api/0_82_runtime_import.md index 2f33a28fb..f29bdd019 100644 --- a/docs/vrm0/0_82_runtime_import.md +++ b/docs/api/0_82_runtime_import.md @@ -1,6 +1,4 @@ -# RuntimeImport(0.82) VRMData - -from `0.82.1` +# `v0.82.1` RuntimeImport VRMData 以下の手順で import します。 diff --git a/docs/vrm0/0_87_runtime_import.md b/docs/api/0_87_runtime_import.md similarity index 97% rename from docs/vrm0/0_87_runtime_import.md rename to docs/api/0_87_runtime_import.md index 6f58ad273..73985603a 100644 --- a/docs/vrm0/0_87_runtime_import.md +++ b/docs/api/0_87_runtime_import.md @@ -1,4 +1,4 @@ -# RuntimeImport(0.87) 非同期ロード +# `v0.87` RuntimeImport 非同期ロード ## awaitCaller 引き数 diff --git a/docs/api/0_95_dispose.md b/docs/api/0_95_dispose.md new file mode 100644 index 000000000..13db12b18 --- /dev/null +++ b/docs/api/0_95_dispose.md @@ -0,0 +1,40 @@ +# `v0.95` GltfData.Dispose + +Importer の内部で `NativeArray` を使うようにしたため、 +終了時にこれを破棄する必要ができました。 +使い終わったら `Dispose` してください。 + +```cs +class GltfData: IDisposable +``` + +## 使用例 + +```cs +// must dispose GltfData +using (GltfData data = new AutoGltfFileParser(path).Parse()) +using (var loader = new UniGLTF.ImporterContext(data, materialGenerator: materialGenerator)) +{ + return await loader.LoadAsync(awaitCaller); +} +``` + +## Dispose しなかった場合 + +NativeArray が Dispose されずに GC に回収されたタイミングで、 +以下のエラーメッセージがコンソールに表示されます。 + +`A Native Collection has not been disposed` + +このエラーがどこで起きたか分からない場合があります。 +`com.unity.jobs package` により詳細メッセージを得ることができます。 + + + +を参考にしてください。 + + +## 関連 + +* +* diff --git a/docs/api/0_95_highlevel.md b/docs/api/0_95_highlevel.md new file mode 100644 index 000000000..009a1f2dd --- /dev/null +++ b/docs/api/0_95_highlevel.md @@ -0,0 +1,3 @@ +# `v0.95` 簡単API + +API が複雑化してきたので、よくある用途を簡単にできる高レベル API を追加しました。 diff --git a/docs/implementation/fast_spring_bone.md b/docs/api/fast_spring_bone.md similarity index 98% rename from docs/implementation/fast_spring_bone.md rename to docs/api/fast_spring_bone.md index 35dfd3d85..15e5b151c 100644 --- a/docs/implementation/fast_spring_bone.md +++ b/docs/api/fast_spring_bone.md @@ -1,4 +1,4 @@ -# FastSpringBoneについて +# `v0.85` FastSpringBoneについて ## 概要 UniVRMでは、DOTSを利用した高速なSpringBone実装である「FastSpringBone」を用意しています。 diff --git a/docs/vrm0/firstperson.md b/docs/api/firstperson.md similarity index 100% rename from docs/vrm0/firstperson.md rename to docs/api/firstperson.md diff --git a/docs/gltf/how_to_customize_material_import.md b/docs/api/how_to_customize_material_import.md similarity index 83% rename from docs/gltf/how_to_customize_material_import.md rename to docs/api/how_to_customize_material_import.md index b78f2b75f..adcf0bf7e 100644 --- a/docs/gltf/how_to_customize_material_import.md +++ b/docs/api/how_to_customize_material_import.md @@ -1,4 +1,4 @@ -# Import 時に生成される Material をカスタマイズする +# `v0.82` Import 時に生成される Material をカスタマイズする `IMaterialDescriptorGenerator` を実装することで import 時に適用されるマテリアルを差し替えることができます。 @@ -19,3 +19,7 @@ async RuntimeGltfInstance Load(GltfData data) } } ``` + +## 関連 + +* diff --git a/docs/gltf/how_to_impl_extension.md b/docs/api/how_to_impl_extension.md similarity index 99% rename from docs/gltf/how_to_impl_extension.md rename to docs/api/how_to_impl_extension.md index d1b6b500e..d3720ad17 100644 --- a/docs/gltf/how_to_impl_extension.md +++ b/docs/api/how_to_impl_extension.md @@ -1,4 +1,4 @@ -# glTF拡張の実装(0.63.2) +# `v0.63.2` glTF拡張の実装 `UniVRM-0.63.2` から `UniGLTF` の構成が変わって、 `extensions` / `extras` の実装方法が変わりました。 diff --git a/docs/api/index.md b/docs/api/index.md new file mode 100644 index 000000000..ace7270b8 --- /dev/null +++ b/docs/api/index.md @@ -0,0 +1,35 @@ +# API + +## Update + +```{toctree} +:maxdepth: 1 +sample/index +firstperson +0_36_update +0_44_runtime_import +0_58_blendshape +how_to_impl_extension +0_68_runtime_import +0_77_runtime_import +0_79_runtime_import +0_82_glb_import +0_82_runtime_import +how_to_customize_material_import +fast_spring_bone +0_87_runtime_import +0_95_dispose +0_95_highlevel +``` + +## VRM-1.0(β) + +```{toctree} +:maxdepth: 2 + +vrm1_runtime_load +vrm1_get_humanoid +vrm1_expression +vrm1_lookat +vrm1_firstperson +``` diff --git a/docs/vrm0/sample/AnimationBridgeSample.md b/docs/api/sample/AnimationBridgeSample.md similarity index 100% rename from docs/vrm0/sample/AnimationBridgeSample.md rename to docs/api/sample/AnimationBridgeSample.md diff --git a/docs/vrm0/sample/FirstPersonSample.md b/docs/api/sample/FirstPersonSample.md similarity index 100% rename from docs/vrm0/sample/FirstPersonSample.md rename to docs/api/sample/FirstPersonSample.md diff --git a/docs/vrm0/sample/RuntimeExporterSample.md b/docs/api/sample/RuntimeExporterSample.md similarity index 100% rename from docs/vrm0/sample/RuntimeExporterSample.md rename to docs/api/sample/RuntimeExporterSample.md diff --git a/docs/vrm0/sample/SimpleViewer.md b/docs/api/sample/SimpleViewer.md similarity index 100% rename from docs/vrm0/sample/SimpleViewer.md rename to docs/api/sample/SimpleViewer.md diff --git a/docs/vrm0/sample/index.md b/docs/api/sample/index.md similarity index 100% rename from docs/vrm0/sample/index.md rename to docs/api/sample/index.md diff --git a/docs/vrm1/vrm1_expression.md b/docs/api/vrm1_expression.md similarity index 100% rename from docs/vrm1/vrm1_expression.md rename to docs/api/vrm1_expression.md diff --git a/docs/vrm1/vrm1_firstperson.md b/docs/api/vrm1_firstperson.md similarity index 100% rename from docs/vrm1/vrm1_firstperson.md rename to docs/api/vrm1_firstperson.md diff --git a/docs/vrm1/vrm1_get_humanoid.md b/docs/api/vrm1_get_humanoid.md similarity index 100% rename from docs/vrm1/vrm1_get_humanoid.md rename to docs/api/vrm1_get_humanoid.md diff --git a/docs/vrm1/vrm1_lookat.md b/docs/api/vrm1_lookat.md similarity index 100% rename from docs/vrm1/vrm1_lookat.md rename to docs/api/vrm1_lookat.md diff --git a/docs/vrm1/vrm1_runtime_load.md b/docs/api/vrm1_runtime_load.md similarity index 100% rename from docs/vrm1/vrm1_runtime_load.md rename to docs/api/vrm1_runtime_load.md diff --git a/docs/conf.py b/docs/conf.py index a1eddc719..7b4b4f45c 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -16,7 +16,7 @@ # -- Project information ----------------------------------------------------- -project = 'UniVRM Programming Document' +project = 'UniVRM Programming' copyright = '2021, VRM Consortium' author = 'VRM Consortium' diff --git a/docs/gltf/index.md b/docs/gltf/index.md deleted file mode 100644 index b8893ffa0..000000000 --- a/docs/gltf/index.md +++ /dev/null @@ -1,23 +0,0 @@ -# glTF - -| version | | -|---------|-------------------------------------------------| -| v0.82.1 | `materialGenerator(URP対応)` 引き数と `VrmData` | -| v0.79 | `GltfData` | -| v0.77 | `RuntimeGltfInstance` | -| v0.68 | `GltfParser` | -| v0.63.2 | gltf の extension の実装方法を変更 | - -```{toctree} -:maxdepth: 1 - -0_82_glb_import -how_to_customize_material_import -0_36_update -``` - -```{toctree} -:maxdepth: 1 -format -how_to_impl_extension -``` diff --git a/docs/gltf/format.md b/docs/implementation/format.md similarity index 100% rename from docs/gltf/format.md rename to docs/implementation/format.md diff --git a/docs/implementation/index.md b/docs/implementation/index.md index 13f6537ea..e4ff186bb 100644 --- a/docs/implementation/index.md +++ b/docs/implementation/index.md @@ -6,8 +6,8 @@ runtime_resource_management texture_manipulation coordinate -fast_spring_bone first_person scripted_importer transparent_zwrite +format ``` diff --git a/docs/index.md b/docs/index.md index 3c2358c84..bf5dccea2 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,22 +1,22 @@ # UniVRM Programming Document -これは、[UniVRM](https://github.com/vrm-c/UniVRM) の開発ドキュメントです。 -UnityでVRMをエクスポートする方法などについては [manual](https://vrm.dev/docs/univrm/) を参照してください。 - ```{toctree} +:caption: Development :maxdepth: 1 - +api/index build implementation/index -gltf/index -unihumanoid/index -vrm0/index -vrm1/index -release/index ``` -# Indices and tables +```{toctree} +:caption: Other +:maxdepth: 1 +release/index +unihumanoid/index +``` -* {ref}`genindex` -* {ref}`modindex` -* {ref}`search` +```{toctree} +:caption: external +UniVRM(github) +VRM +``` diff --git a/docs/vrm0/index.md b/docs/vrm0/index.md deleted file mode 100644 index 85f0f5dc8..000000000 --- a/docs/vrm0/index.md +++ /dev/null @@ -1,22 +0,0 @@ -# VRM - -```{toctree} -:maxdepth: 1 - -sample/index -0_87_runtime_import -0_82_runtime_import -0_79_runtime_import -0_77_runtime_import -0_68_runtime_import -0_44_runtime_import -0_58_blendshape -firstperson -``` - -* {doc}`FastSpringBone(0.85) ` - -## TODO: - -* 🚧 materialGenerator -* 🚧 firstPerson diff --git a/docs/vrm1/index.md b/docs/vrm1/index.md deleted file mode 100644 index e4c42fd84..000000000 --- a/docs/vrm1/index.md +++ /dev/null @@ -1,15 +0,0 @@ -# VRM-1.0(β) - -```{toctree} -:maxdepth: 2 - -vrm1_runtime_load -vrm1_get_humanoid -vrm1_expression -vrm1_lookat -vrm1_firstperson -``` - -## Samples - -- VRM10Viewer