Merge pull request #37 from unity3d-jp/docs

docs: Move README_EN under Documentation~ and add Japanese license

README_EN.md → Documentation~/README_EN.md

@@ -1,6 +1,6 @@
 ![demo](https://user-images.githubusercontent.com/1488611/60965577-1ca89700-a351-11e9-9b7d-962a6a7e1aed.png)
 # Raytraced Hard Shadow
-[Japanese](https://github.com/unity3d-jp/RaytracedHardShadow/blob/master/Readme.md)
+[Japanese](Readme.md)
 
 
 This plugin is for creating pixel-level precise hard shadows using ray tracing. Combine this plugin with tools like [UnityChanToonShader](https://github.com/unity3d-jp/UnityChanToonShaderVer2_Project) to create an anime-style shadow system. 
@@ -110,4 +110,4 @@ This option is ideal for special cases such as wanting to use the shadow buffer
   - Support for these cases would be difficult, and is unlikely in future updates. 
 
 ## License
-[Unity Companion License](LICENSE.md) 
+[Unity Companion License](https://github.com/unity3d-jp/RaytracedHardShadow/blob/master/LICENSE_EN.md) 

Documentation~/Readme.md

@@ -0,0 +1,113 @@
+![demo](https://user-images.githubusercontent.com/1488611/60965577-1ca89700-a351-11e9-9b7d-962a6a7e1aed.png)
+# Raytraced Hard Shadow
+[English](README_EN.md)
+
+
+レイトレーシングにより、ピクセル単位の正確なハードシャドウを生成するプラグインです。[UnityChanToonShader](https://github.com/unity3d-jp/UnityChanToonShaderVer2_Project) などと併用することを想定した、アニメ用影システムとなります。
+
+実行には DirectX Raytracing (DXR) が動作する環境が必要です。
+具体的には、**Windows 10 の 1809 (October 2018 Update) 以降、GeForce 1070 以上の GPU が必須** になります。  
+ 2019/07 現在、NVIDIA の GPU (GeForce および Quadro) しか DXR をサポートしていません。また、GeForce 1060 には DXR をサポートしているモデルとしていないモデルが混在しており、同 GPU でも動く可能性はあります。([DXR Supported GPUs 2019/03](https://www.nvidia.com/content/dam/en-zz/Solutions/geforce/news/geforce-rtx-gtx-dxr/geforce-rtx-gtx-dxr-supported-gpus-march-2019.png) によれば、GTX 1060 **6GB** はサポートしているようです)
+
+Unity 2017.4 以降 で動作します。Unity 側のグラフィック API は D3D11 (デフォルト)、もしくは D3D12 である必要があります。
+
+## 使い方
+- [releases](https://github.com/unity3d-jp/RaytracedHardShadow/releases) からパッケージをダウンロードし、Unity のプロジェクトにインポート。
+  - Unity 2018.3 以降の場合、この github リポジトリを直接インポートすることもできます。プロジェクト内にある Packages/manifest.json をテキストエディタで開き、"dependencies" に以下の行を加えます。
+  > "com.unity.raytracedhardshadow": "https://github.com/unity3d-jp/RaytracedHardShadow.git",
+
+- Camera を選択し、"Add Component" -> "UTJ/Raytraced Hard Shadow/Shadow Raytacer" を選択。このコンポーネントが影生成を担当します。
+
+<img align="right" src="https://user-images.githubusercontent.com/1488611/61529039-4b162880-aa5b-11e9-9a64-57429f21b8ce.png" width=400>
+
+### Shadow Raytracer
+
+#### Output
+##### Generate Render Texture
+これが有効な場合、出力先の影テクスチャを画面の解像度に合わせて自動的に作成/更新します。
+既存の RenderTexture を出力先としたい場合、このオプションを無効化して "Output Texture" を手動で設定します。
+
+**RenderTexture が 32bit の Int もしくは Uint のフォーマットである場合、bitmask として出力します**。"Generate Render Texture" が有効な場合、"Output Type" を "Bit Mask" にすると bitmask になります。  
+bitmask の場合、n 番目の bit が n 番目のライトに対応するようになります。例えば、あるピクセルが 0 番目と 2 番目のライトの光を受ける場合、(1 << 0) | (1 << 2) で 5 が出力されます。シェーダで複数のライトの影に対応する場合、この bitmask の値を用いてライト毎の影を判別します。  
+["Set Light Index To Alpha"](#set-light-index-to-alpha) も参照ください。
+
+##### Assign Global Texture
+これが有効な場合、影テクスチャをグローバルなシェーダパラメータとして設定します。パラメータ名は "Global Texture Name" に設定した名前になります。
+
+#### Shadows
+##### Use Camera Culling Mask
+有効な場合、Camera に設定されている Culling Mask をそのまま影生成時にも適用します。
+無効な場合 Camera の Culling Mask は無視しますが、"Use Light Culling Mask" が有効な場合は Light 側の Culling Mask の影響は受けます。
+
+##### Cull Back Faces
+有効な場合、裏面カリングを行います。
+
+##### Ignore Self Shadow
+自分自身に落とす影 (セルフシャドウ) を無視します。  
+"Keep Self Drop Shadow" が有効な場合、レイが遮られるまでの距離がほぼゼロ ("Self Shadow Threshold" で調節可) であればその遮ったオブジェクトは無視しますが、それ以上であれば自分自身であっても影とみなします。  
+
+デフォルトでは "Ignore Self Shadow" "Keep Self Drop Shadow" 共に有効となっており、通常これが最も望ましい動作であると思われます。  
+ハードシャドウはポリゴンの形状がはっきり影になるため、セルフシャドウの境界が角張ってしまいます。
+そのため、セルフシャドウに関してはシェーディング (光源方向と法線から陰を判別) に任せた方がきれいな結果が得られます。
+しかしそれだけだと、例えば鼻や耳が顔に落とす影が出なくなってしまいます。同じセルフシャドウでも落ち影は保った方がいいでしょう。
+デフォルト設定はこれらの要件を満たすものになっています。
+![Self Shadow Options](https://user-images.githubusercontent.com/1488611/61041749-d402e380-a40d-11e9-8698-ef0eedea7770.png)
+
+#### Lights
+##### Use Light Shadow Settings
+有効な場合、Light の "Shadow Type" が "No Shadows" のものは無視します。  
+"Soft Shadows" と "Hard Shadows" は区別しません。どちらの場合も同じ処理で影テクスチャを生成します。
+
+##### Use Light Culling bitmask
+有効な場合、Light に設定されている Culling Mask をそのまま影生成時にも適用します。  
+無効な場合その Light の Culling Mask は無視しますが、"Use Camera Culling Mask" が有効な場合 Camera 側の Culling Mask の影響は受けます。
+
+##### Set Light Index To Alpha
+有効な場合、Light のインデックスを alpha に設定します。  
+影バッファを bitmask として出力した場合、この値を用いてライトと影の bit の関連付けを行います。
+最初のライトが 1000、以降 2000, 3000... と続きます。(デフォルトの alpha が 1 であるため、無関係なライトと混ざらないようにするために 1000 を初期値としています)  
+Legacy Forward の場合、シェーダ側では_LightColor0.aでこの値を取れます。  
+["Generate Render Texture"](#generate-render-texture) も参照ください。また、**デフォルトでは無効** である点にご注意ください。
+
+##### Light Scope
+"Entire Scene" の場合、シーン上の全ライトを用います。"Scene" の場合指定のシーン内に存在するライトを用います。"Objects" の場合指定オブジェクトのみ用います。  
+エリアライトは非サポートであり、無視されます。
+
+#### Geometry
+##### Use Object Shadow Settings
+有効な場合、MeshRenderer / SkinnedMeshRenderer の "Cast Shadows" と "Receive Shadows" を影設定に適用します。  
+"Cast Shadows" が Off であれば影をキャストせず、Shadows Only であればカメラには映らず影だけキャストする、といった具合です。
+無効な場合、常に影のキャストとレシーブ両方を有効にします。
+
+##### Geometry Scope
+影のキャスト、レシーブを行うオブジェクトを指定します。こちらも Lights 同様、全シーン、シーン単位、オブジェクト単位での指定が可能です。オブジェクト指定の場合、指定オブジェクトの子オブジェクトも含められます。
+
+#### Misc
+##### GPU Skinning
+スキニングおよびブレンドシェイプを GPU で行い、高速化を図るオプションです。  
+本プラグインは Unity 側とは独立して Mesh データを持っており、このオプションが有効だとスキニングも独立して行うようになります。
+もし Unity 側と影側でモデルの不一致が確認された場合、このオプションを無効化すると改善される可能性があります。(不一致 = 本プラグインの不具合 でもあるため、再現できるデータと一緒にレポートいただけるととても助かります)  
+無効な場合、Unity 側で bake した結果をプラグインに送ります。そのため Mesh データは確実に正確になりますが、代償として大幅に遅くなります。
+
+##### Adaptive Sampling
+これが有効な場合、若干のクオリティの低下と引き換えにレンダリングの大幅な高速化を行います。  
+どれくらい速くなるかシーンの複雑さに左右されますが、冒頭の画像のシーン ([Unity-Chan CRS](https://github.com/unity3d-jp/unitychan-crs)) で概ね 3 倍以上速くなっています (18ms -> 5ms)。
+クオリティの低下とは具体的には、細かいディティールが潰れてしまいます。例えば 2 ピクセル刻みの網目模様のような箇所が真っ黒になるといった現象が発生します。  
+作業中は有効にしてプレビューを高速化し、最終出力の際は切る、といった使い方が考えられます。
+
+##### Antialiasing
+アンチエイリアシングをかけます。  
+トゥーンシェーダと併用する場合、これは望ましくない結果を招くと思われます。(オブジェクトの境界付近に汚れが出るなど) 
+影バッファをそれ単独で絵として使いたいような特殊なケース用のオプションです。
+
+## 制限事項、既知の問題など
+- レンダリング対象は現在 MeshRenderer と SkinnedMeshRenderer のみ対応しています。
+  - ParticleSystem、Terrain などは未対応です。
+- アルファテスト、半透明、Stencil による切り抜きは未対応です。
+  - これらは将来的に対応する可能性があります。
+- シェーダ内でモデルが変化する処理を入れている場合、それは影側には反映されず不一致が発生します。
+  - 頂点シェーダで特殊な変形を行っている場合や、Geometry Shader や Tessellation でポリゴンの増減を行っている場合などが該当します。
+  - これらは対応が難しく、将来的にも対応する見込みは薄いです。
+
+## ライセンス
+[Unity Companion License](https://github.com/unity3d-jp/RaytracedHardShadow/blob/master/LICENSE.md) 

LICENSE.md

@@ -1,7 +1,6 @@
 ## Raytraced Hard Shadow
 
-copyright © 2019 Unity Technologies ApS
+本パッケージは Unity に付随するプロジェクトに適用される Unity Companion License に基づいて使用が許諾されています。詳細は、[Unity Companion License の本文](http://www.unity3d.com/jp/legal/licenses/Unity_Companion_License) (英語) をご確認ください。
+​
+別に明示的な定めがない限り、本ライセンスに基づくソフトウェアは厳密に「現状のまま」で、明示であるか暗黙であるかを問わず、何らの保証もなく提供されます。本利用規約およびその他の利用規約に関する詳細については、ライセンス本文をご確認ください。
 
-Licensed under the Unity Companion License for Unity-dependent projects--see [Unity Companion License](http://www.unity3d.com/legal/licenses/Unity_Companion_License). 
-
-Unless expressly provided otherwise, the Software under this license is made available strictly on an “AS IS” BASIS WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED. Please review the license for details on these and other terms and conditions.

LICENSE_EN.md

@@ -0,0 +1,7 @@
+## Raytraced Hard Shadow
+
+copyright © 2019 Unity Technologies ApS
+
+Licensed under the Unity Companion License for Unity-dependent projects--see [Unity Companion License](http://www.unity3d.com/legal/licenses/Unity_Companion_License). 
+
+Unless expressly provided otherwise, the Software under this license is made available strictly on an “AS IS” BASIS WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED. Please review the license for details on these and other terms and conditions.

Readme.md

@@ -1,6 +1,6 @@
 ![demo](https://user-images.githubusercontent.com/1488611/60965577-1ca89700-a351-11e9-9b7d-962a6a7e1aed.png)
 # Raytraced Hard Shadow
-[English](https://translate.google.com/translate?sl=ja&tl=en&u=https://github.com/unity3d-jp/RaytracedHardShadow)
+[English](Documentation~/README_EN.md)
 
 
 レイトレーシングにより、ピクセル単位の正確なハードシャドウを生成するプラグインです。[UnityChanToonShader](https://github.com/unity3d-jp/UnityChanToonShaderVer2_Project) などと併用することを想定した、アニメ用影システムとなります。