Shadow CasterのReadme更新

CyberAgentGameEntertainment · Feb 7, 2024 · 9d4621e · 9d4621e
1 parent 050c9ee
commit 9d4621e
Show file tree

Hide file tree

Showing 4 changed files with 210 additions and 76 deletions.
diff --git a/Documentation~/Images/shadow_caster_01.png b/Documentation~/Images/shadow_caster_01.png
diff --git a/Documentation~/Images/shadow_caster_demo01.gif b/Documentation~/Images/shadow_caster_demo01.gif
diff --git a/README.md b/README.md
@@ -40,44 +40,47 @@ For more information, please refer to the following documents, [Samples](Assets/
 <details>
 <summary>Details</summary>
 
-- [Setup](#setup)
-  - [Requirements](#requirements)
-    - [Install](#install)
-- [Usage](#usage)
-    - [Add Renderer Feature](#add-renderer-feature)
-    - [Activate Depth Texture](#activate-depth-texture)
-    - [Create and assign the Material](#create-and-assign-the-material)
-- [Uber Unlit Shader](#uber-unlit-shader)
-    - [Render Settings](#render-settings)
-    - [Vertex Deformation](#vertex-deformation)
-    - [Base Map](#base-map)
-    - [Tint Color](#tint-color)
-    - [Flow Map](#flow-map)
-    - [Parallax Map](#parallax-map)
-    - [Color Correction](#color-correction)
-    - [Alpha Transition](#alpha-transition)
-    - [Emission](#emission)
-    - [Transparency](#transparency)
-- [Uber Lit Shader](#uber-lit-shader)
-    - [Render Settings](#render-settings-1)
-    - [Surface Maps](#surface-maps)
-- [Distortion Shader](#distortion-shader)
-    - [Render Settings](#render-settings-2)
-    - [Distortion](#distortion)
-    - [Flow Map](#flow-map-1)
-    - [Alpha Transition](#alpha-transition-1)
-    - [Transparency](#transparency-1)
-- [Use with the Custom Vertex Streams](#use-with-the-custom-vertex-streams)
-    - [Set up the Custom Data](#set-up-the-custom-data)
-    - [Set up the Custom Vertex Streams](#set-up-the-custom-vertex-streams)
-    - [Set up the Material Property](#set-up-the-material-property)
-- [Use Mesh GPU Instancing](#use-mesh-gpu-instancing)
-    - [Enable Mesh GPU Instancing](#enable-mesh-gpu-instancing)
-    - [Set up the Custom Vertex Streams](#set-up-the-custom-vertex-streams-1)
-- [Automatic set up the Custom Vertex Streams.](#automatic-set-up-the-custom-vertex-streams)
-    - [Fix Now](#fix-now)
-- [Editor APIs Reference](#editor-apis-reference)
-- [Licenses](#licenses)
+- [NOVA Shader: Uber shader for Particle System](#nova-shader-uber-shader-for-particle-system)
+  - [Table of Contents](#table-of-contents)
+  - [Setup](#setup)
+    - [Requirements](#requirements)
+      - [Install](#install)
+  - [Usage](#usage)
+      - [Add Renderer Feature](#add-renderer-feature)
+      - [Activate Depth Texture](#activate-depth-texture)
+      - [Create and assign the Material](#create-and-assign-the-material)
+  - [Uber Unlit Shader](#uber-unlit-shader)
+      - [Render Settings](#render-settings)
+      - [Vertex Deformation](#vertex-deformation)
+      - [Base Map](#base-map)
+      - [Tint Color](#tint-color)
+      - [Flow Map](#flow-map)
+      - [Parallax Map](#parallax-map)
+      - [Color Correction](#color-correction)
+      - [Alpha Transition](#alpha-transition)
+      - [Emission](#emission)
+      - [Transparency](#transparency)
+  - [Uber Lit Shader](#uber-lit-shader)
+      - [Render Settings](#render-settings-1)
+      - [Surface Maps](#surface-maps)
+  - [Distortion Shader](#distortion-shader)
+      - [Render Settings](#render-settings-2)
+      - [Distortion](#distortion)
+      - [Flow Map](#flow-map-1)
+      - [Alpha Transition](#alpha-transition-1)
+      - [Transparency](#transparency-1)
+  - [Abort Shadow Caster](#abort-shadow-caster)
+  - [Use with the Custom Vertex Streams](#use-with-the-custom-vertex-streams)
+      - [Set up the Custom Data](#set-up-the-custom-data)
+      - [Set up the Custom Vertex Streams](#set-up-the-custom-vertex-streams)
+      - [Set up the Material Property](#set-up-the-material-property)
+  - [Use Mesh GPU Instancing](#use-mesh-gpu-instancing)
+      - [Enable Mesh GPU Instancing](#enable-mesh-gpu-instancing)
+      - [Set up the Custom Vertex Streams](#set-up-the-custom-vertex-streams-1)
+  - [Automatic set up the Custom Vertex Streams.](#automatic-set-up-the-custom-vertex-streams)
+      - [Fix Now](#fix-now)
+  - [Editor APIs Reference](#editor-apis-reference)
+  - [Licenses](#licenses)
 
 </details>
 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
@@ -1322,6 +1325,65 @@ The distance from the beginning of transparency to the end of complete transpare
 </tbody>
 </table>
 
+## Abort Shadow Caster
+Enabling the Shadow Caster feature will allow you to cast shadows from NovaShader.
+<p align="center">
+  <img width="60%" src="Documentation~/Images/shadow_caster_01.png" alt="Shadow Caster"><br>
+  <font color="grey">Shadow Caster</font>
+</p>
+<table width="100%">
+<thead>
+<tr><td colspan="3"><b>Property Name</b></td><td><b>Discription</b></td></tr>
+</thead>
+<tbody>
+<tr><td colspan="3"><b>Enable</b></td><td>
+<p>
+Check this to enable ShadowCasterPass
+</p>
+</td></tr>
+<tr><td colspan="3"><b>Apply Vertex Deformation</b></td><td>
+<p>
+If checked, Vertex Deformation will be applied to shadow casting calculations
+</p>
+</td></tr>
+<tr><td colspan="3"><b>Alpha Test Enable</b></td><td>
+<p>
+If checked, Alpha Test will be enabled for calculating shadow casting, and shadows will not be cast in areas that do not pass.<br>
+</p>
+</td></tr>
+<tr><td></td><td colspan="2"><b>Cutoff</b></td><td>
+<p>
+Areas where the Alpha value is less than the Cutoff value will not cast a shadow (this will be a different value from the Cutoff of the drawing process)
+</p>
+</td></tr>
+<tr><td colspan="3"><b>Alpha Affected By</b></td><td>
+<p>
+Items that affect Alpha value during shadow casting calculation
+</p>
+</td></tr>
+<tr><td></td><td colspan="2"><b>Tint Color</b></td><td>
+<p>
+If checked, Tint Color will affect Alpha value
+</p>
+</td></tr>
+<tr><td></td><td colspan="2"><b>FlowMap</b></td><td>
+<p>
+If checked, Flow　Map will affect Alpha value
+</p>
+</td></tr>
+<tr><td></td><td colspan="2"><b>Alpha Transition Map</b></td><td>
+<p>
+If checked, Alpha Transition Map will affect Alpha value
+</p>
+</td></tr>
+<tr><td></td><td colspan="2"><b>Transparency Luminance</b></td><td>
+<p>
+If checked, Transparency Luminance will affect Alpha value
+</p>
+</td></tr>
+</tbody>
+</table>
+
 ## Use with the Custom Vertex Streams
 Using the Particle System's Custom Vertex Streams, you can animate the properties of the Material.
 In the following example, we will use the Custom Vertex Streams to rotate the texture.

diff --git a/README_JA.md b/README_JA.md
@@ -41,44 +41,47 @@
 <details>
 <summary>詳細</summary>
 
-- [セットアップ](#%E3%82%BB%E3%83%83%E3%83%88%E3%82%A2%E3%83%83%E3%83%97)
-    - [要件](#%E8%A6%81%E4%BB%B6)
-    - [インストール](#%E3%82%A4%E3%83%B3%E3%82%B9%E3%83%88%E3%83%BC%E3%83%AB)
-- [使い方](#%E4%BD%BF%E3%81%84%E6%96%B9)
-    - [Renderer Feature を登録](#renderer-feature-%E3%82%92%E7%99%BB%E9%8C%B2)
-    - [Depth Textureを有効化](#depth-texture%E3%82%92%E6%9C%89%E5%8A%B9%E5%8C%96)
-    - [マテリアル作成、アサイン](#%E3%83%9E%E3%83%86%E3%83%AA%E3%82%A2%E3%83%AB%E4%BD%9C%E6%88%90%E3%82%A2%E3%82%B5%E3%82%A4%E3%83%B3)
-- [Uber Unlitシェーダ](#uber-unlit%E3%82%B7%E3%82%A7%E3%83%BC%E3%83%80)
-    - [Render Settings](#render-settings)
-    - [Vertex Deformation](#vertex-deformation)
-    - [Base Map](#base-map)
-    - [Tint Color](#tint-color)
-    - [Flow Map](#flow-map)
-    - [Parallax Map](#parallax-map)
-    - [Color Correction](#color-correction)
-    - [Alpha Transition](#alpha-transition)
-    - [Emission](#emission)
-    - [Transparency](#transparency)
-- [Uber Litシェーダー](#uber-lit%E3%82%B7%E3%82%A7%E3%83%BC%E3%83%80%E3%83%BC)
-    - [Render Settings](#render-settings-1)
-    - [Surface Maps](#surface-maps)
-- [Distortionシェーダ](#distortion%E3%82%B7%E3%82%A7%E3%83%BC%E3%83%80)
-    - [Render Settings](#render-settings-2)
-    - [Distortion](#distortion)
-    - [Flow Map](#flow-map-1)
-    - [Alpha Transition](#alpha-transition-1)
-    - [Transparency](#transparency-1)
-- [Custom Vertex Streamsとの連携](#custom-vertex-streams%E3%81%A8%E3%81%AE%E9%80%A3%E6%90%BA)
-    - [Custom Dataを設定](#custom-data%E3%82%92%E8%A8%AD%E5%AE%9A)
-    - [Custom Vertex Streamsを設定する](#custom-vertex-streams%E3%82%92%E8%A8%AD%E5%AE%9A%E3%81%99%E3%82%8B)
-    - [マテリアルプロパティを設定する](#%E3%83%9E%E3%83%86%E3%83%AA%E3%82%A2%E3%83%AB%E3%83%97%E3%83%AD%E3%83%91%E3%83%86%E3%82%A3%E3%82%92%E8%A8%AD%E5%AE%9A%E3%81%99%E3%82%8B)
-- [Mesh GPU Instancingを使う](#mesh-gpu-instancing%E3%82%92%E4%BD%BF%E3%81%86)
-    - [Mesh GPU Instancingを有効化する](#mesh-gpu-instancing%E3%82%92%E6%9C%89%E5%8A%B9%E5%8C%96%E3%81%99%E3%82%8B)
-    - [Custom Vertex Streamsを設定する](#custom-vertex-streams%E3%82%92%E8%A8%AD%E5%AE%9A%E3%81%99%E3%82%8B-1)
-- [Custom Vertex Streamsを自動的に設定する](#custom-vertex-streams%E3%82%92%E8%87%AA%E5%8B%95%E7%9A%84%E3%81%AB%E8%A8%AD%E5%AE%9A%E3%81%99%E3%82%8B)
-    - [Fix Now](#fix-now)
-- [Editor APIs リファレンス](#editor-apis-%E3%83%AA%E3%83%95%E3%82%A1%E3%83%AC%E3%83%B3%E3%82%B9)
-- [ライセンス](#%E3%83%A9%E3%82%A4%E3%82%BB%E3%83%B3%E3%82%B9)
+- [NOVA Shader: Particle System用多機能シェーダ](#nova-shader-particle-system用多機能シェーダ)
+  - [目次](#目次)
+  - [セットアップ](#セットアップ)
+      - [要件](#要件)
+      - [インストール](#インストール)
+  - [使い方](#使い方)
+      - [Renderer Feature を登録](#renderer-feature-を登録)
+      - [Depth Textureを有効化](#depth-textureを有効化)
+      - [マテリアル作成、アサイン](#マテリアル作成アサイン)
+  - [Uber Unlitシェーダ](#uber-unlitシェーダ)
+      - [Render Settings](#render-settings)
+      - [Vertex Deformation](#vertex-deformation)
+      - [Base Map](#base-map)
+      - [Tint Color](#tint-color)
+      - [Flow Map](#flow-map)
+      - [Parallax Map](#parallax-map)
+      - [Color Correction](#color-correction)
+      - [Alpha Transition](#alpha-transition)
+      - [Emission](#emission)
+      - [Transparency](#transparency)
+  - [Uber Litシェーダー](#uber-litシェーダー)
+      - [Render Settings](#render-settings-1)
+      - [Surface Maps](#surface-maps)
+  - [Distortionシェーダ](#distortionシェーダ)
+      - [Render Settings](#render-settings-2)
+      - [Distortion](#distortion)
+      - [Flow Map](#flow-map-1)
+      - [Alpha Transition](#alpha-transition-1)
+      - [Transparency](#transparency-1)
+  - [影を落とす機能について](#影を落とす機能について)
+  - [Custom Vertex Streamsとの連携](#custom-vertex-streamsとの連携)
+      - [Custom Dataを設定](#custom-dataを設定)
+      - [Custom Vertex Streamsを設定する](#custom-vertex-streamsを設定する)
+      - [マテリアルプロパティを設定する](#マテリアルプロパティを設定する)
+  - [Mesh GPU Instancingを使う](#mesh-gpu-instancingを使う)
+      - [Mesh GPU Instancingを有効化する](#mesh-gpu-instancingを有効化する)
+      - [Custom Vertex Streamsを設定する](#custom-vertex-streamsを設定する-1)
+  - [Custom Vertex Streamsを自動的に設定する](#custom-vertex-streamsを自動的に設定する)
+      - [Fix Now](#fix-now)
+  - [Editor APIs リファレンス](#editor-apis-リファレンス)
+  - [ライセンス](#ライセンス)
 
 </details>
 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
@@ -1330,6 +1333,75 @@ Transparencyは透明度を調整できます。
 </tbody>
 </table>
 
+## 影を落とす機能について
+Shadow Caster機能を有効にするとNovaShaderから影を落とすことができるようになります
+<p align="center">
+  <img width="60%" src="Documentation~/Images/shadow_caster_01.png" alt="Shadow Caster"><br>
+  <font color="grey">Shadow Caster</font>
+</p>
+<table width="100%">
+<thead>
+<tr><td colspan="3"><b>プロパティ名</b></td><td><b>説明</b></td></tr>
+</thead>
+<tbody>
+<tr><td colspan="3"><b>Enable</b></td><td>
+<p>
+チェックをつけるとShadowCasterPassが有効になります
+</p>
+</td></tr>
+<tr><td colspan="3"><b>Apply Vertex Deformation</b></td><td>
+<p>
+チェックをつけると影投射の計算にVertex Deformationが反映されます。
+</p>
+</td></tr>
+<tr><td colspan="3"><b>Alpha Test Enable</b></td><td>
+<p>
+チェックをつけると影投射の計算にAlpha Testが有効になり、通らないところは影を落とさないことになります<br>
+</p>
+</td></tr>
+<tr><td></td><td colspan="2"><b>Cutoff</b></td><td>
+<p>
+Alpha値がCutoff値以下の部分は影を落とさないことになります（描画処理のCutoffと別の値になります）
+</p>
+</td></tr>
+<tr><td colspan="3"><b>Alpha Affected By</b></td><td>
+<p>
+影投射計算中Alpha値に反映する項目
+</p>
+</td></tr>
+<tr><td></td><td colspan="2"><b>Tint Color</b></td><td>
+<p>
+チェックつけると、Tint ColorがAlpha値に反映されます
+</p>
+</td></tr>
+<tr><td></td><td colspan="2"><b>FlowMap</b></td><td>
+<p>
+チェックつけると、Flow MapがAlpha値に反映されます
+</p>
+</td></tr>
+<tr><td></td><td colspan="2"><b>Alpha Transition Map</b></td><td>
+<p>
+チェックつけると、Alpha Transition MapがAlpha値に反映されます
+</p>
+</td></tr>
+<tr><td></td><td colspan="2"><b>Transparency Luminance</b></td><td>
+<p>
+チェックつけると、Transparency LuminanceがAlpha値に反映されます
+</p>
+</td></tr>
+</tbody>
+</table>
+
+<p align="center">
+  <img width="60%" src="Documentation~/Images/shadow_caster_demo01.gif" alt="Shadow Caster Demo"><br>
+  <font color="grey">Shadow Caster Demo</font>
+</p>
+<table width="100%">
+<thead>
+<tr><td colspan="3"><b>プロパティ名</b></td><td><b>説明</b></td></tr>
+</thead>
+<tbody>
+
 ## Custom Vertex Streamsとの連携
 Particle SystemのCustom Vertex Streamsを使うと、マテリアルのプロパティを自由にアニメーションさせることができます。  
 以下では例として、Custom Vertex Streamsを使ってテクスチャを回転させる手順を説明します。