ドキュメント整理

docs/api/0_36_update.md

@@ -1,4 +1,4 @@
-# GltfUpdate(0.36)
+# `v0.36` GltfUpdate
 
 ## テクスチャ名の格納位置の修正
 

docs/api/0_44_runtime_import.md

@@ -1,4 +1,4 @@
-# RuntimeImport(0.44)
+# `v0.44` RuntimeImport
 
 ## `Version 0.44～` LoadAsyncの例 
 

docs/api/0_58_blendshape.md

@@ -1,4 +1,4 @@
-# BlendShapeProxy(0.58)
+# `v0.58` BlendShapeProxy
 
 ## BlendShapeKeyのインタフェースを厳格化、整理
 

docs/api/0_68_runtime_import.md

@@ -1,4 +1,4 @@
-# RuntimeImport(0.68) DisposeOnGameObjectDestroyed(obsolete)
+# `v0.68` RuntimeImport DisposeOnGameObjectDestroyed(obsolete)
 
 ## 過去バージョンからの仕様変更
 

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)
 

docs/api/0_79_runtime_import.md

@@ -1,4 +1,4 @@
-# RuntimeImport(0.79) GltfData
+# `v0.79` RuntimeImport GltfData
 
 `GltfParser` と `GltfData` の分割
 

docs/api/0_82_glb_import.md

@@ -1,5 +1,4 @@
-# GlbImport(0.82) GltfData
-from: `0.82.1`
+# `v0.82.1` GlbImport GltfData
 
 以下のステップでロードします。
 

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 します。
 

docs/api/0_87_runtime_import.md

@@ -1,4 +1,4 @@
-# RuntimeImport(0.87) 非同期ロード
+# `v0.87` RuntimeImport 非同期ロード
 
 ## awaitCaller 引き数
 

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` により詳細メッセージを得ることができます。
+
+<https://forum.unity.com/threads/a-native-collection-has-not-been-disposed-enable-full-stack.1098973/>
+
+を参考にしてください。
+
+
+## 関連
+
+* <https://github.com/vrm-c/UniVRM/pull/1483>
+* <https://github.com/vrm-c/UniVRM/pull/1503>

docs/api/0_95_highlevel.md

@@ -0,0 +1,3 @@
+# `v0.95` 簡単API
+
+API が複雑化してきたので、よくある用途を簡単にできる高レベル API を追加しました。

docs/api/fast_spring_bone.md

@@ -1,4 +1,4 @@
-# FastSpringBoneについて
+# `v0.85` FastSpringBoneについて
 
 ## 概要
 UniVRMでは、DOTSを利用した高速なSpringBone実装である「FastSpringBone」を用意しています。

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)
     }
 }
 ```
+
+## 関連
+
+* <https://github.com/vrm-c/UniVRM/pull/1177>

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` の実装方法が変わりました。
 

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
+```

docs/conf.py

@@ -16,7 +16,7 @@
 
 # -- Project information -----------------------------------------------------
 
-project = 'UniVRM Programming Document'
+project = 'UniVRM Programming'
 copyright = '2021, VRM Consortium'
 author = 'VRM Consortium'
 

docs/gltf/index.md

@@ -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
-```

docs/implementation/index.md

@@ -6,8 +6,8 @@
 runtime_resource_management
 texture_manipulation
 coordinate
-fast_spring_bone
 first_person
 scripted_importer
 transparent_zwrite
+format
 ```

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) <https://github.com/vrm-c/UniVRM>
+VRM <https://vrm.dev/>
+```

docs/vrm0/index.md

@@ -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) </implementation/fast_spring_bone>`
-
-## TODO:
-
-* 🚧 materialGenerator
-* 🚧 firstPerson

docs/vrm1/index.md

@@ -1,15 +0,0 @@
-# VRM-1.0(β)
-
-```{toctree}
-:maxdepth: 2
-
-vrm1_runtime_load
-vrm1_get_humanoid
-vrm1_expression
-vrm1_lookat
-vrm1_firstperson
-```
-
-## Samples
-
-- VRM10Viewer