Merge pull request #63 from Looooong/add-usage-to-readme

Add Usage to Readme

Author: Looooong

.github/FUNDING.yml

@@ -1,9 +1 @@
-# These are supported funding model platforms
-
-github: []
 patreon: Looooong
-open_collective: # Replace with a single Open Collective username
-ko_fi: # Replace with a single Ko-fi username
-tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
-community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
-custom: # Replace with a single custom sponsorship URL

Editor.meta

@@ -0,0 +1,17 @@
+{
+    "name": "Looooong.SRP.VXGI.Editor",
+    "references": [
+        "GUID:2518aed04e27c9a489552a3a49b8243f"
+    ],
+    "includePlatforms": [
+        "Editor"
+    ],
+    "excludePlatforms": [],
+    "allowUnsafeCode": false,
+    "overrideReferences": false,
+    "precompiledReferences": [],
+    "autoReferenced": true,
+    "defineConstraints": [],
+    "versionDefines": [],
+    "noEngineReferences": false
+}

Editor/Looooong.SRP.VXGI.Editor.asmdef

@@ -0,0 +1,63 @@
+using UnityEditor;
+using UnityEngine;
+
+namespace VXGIEditor {
+  [CustomEditor(typeof(VXGI))]
+  public class VXGIEditor : Editor {
+    MonoScript _script;
+    SerializedProperty _antiAliasing;
+    SerializedProperty _bound;
+    SerializedProperty _center;
+    SerializedProperty _diffuseResolutionScale;
+    SerializedProperty _followCamera;
+    SerializedProperty _indirectDiffuseModifier;
+    SerializedProperty _indirectSpecularModifier;
+    SerializedProperty _limitRefreshRate;
+    SerializedProperty _mipmapFilterMode;
+    SerializedProperty _refreshRate;
+    SerializedProperty _resolution;
+
+    public override void OnInspectorGUI() {
+      serializedObject.Update();
+
+      using (new EditorGUI.DisabledScope(true)) {
+        EditorGUILayout.ObjectField("Script", _script, typeof(MonoScript), false);
+      }
+
+      EditorGUILayout.PropertyField(_followCamera);
+
+      using (new EditorGUI.DisabledScope(_followCamera.boolValue)) {
+        EditorGUILayout.PropertyField(_center);
+      }
+
+      EditorGUILayout.PropertyField(_bound);
+      EditorGUILayout.PropertyField(_resolution);
+      EditorGUILayout.PropertyField(_antiAliasing);
+      EditorGUILayout.PropertyField(_mipmapFilterMode);
+      EditorGUILayout.PropertyField(_limitRefreshRate);
+
+      if (_limitRefreshRate.boolValue) EditorGUILayout.PropertyField(_refreshRate);
+
+      EditorGUILayout.PropertyField(_indirectDiffuseModifier);
+      EditorGUILayout.PropertyField(_indirectSpecularModifier);
+      EditorGUILayout.PropertyField(_diffuseResolutionScale);
+
+      serializedObject.ApplyModifiedProperties();
+    }
+
+    void OnEnable() {
+      _script = MonoScript.FromMonoBehaviour((VXGI)target);
+      _antiAliasing = serializedObject.FindProperty("antiAliasing");
+      _bound = serializedObject.FindProperty("bound");
+      _center = serializedObject.FindProperty("center");
+      _diffuseResolutionScale = serializedObject.FindProperty("diffuseResolutionScale");
+      _followCamera = serializedObject.FindProperty("followCamera");
+      _indirectDiffuseModifier = serializedObject.FindProperty("indirectDiffuseModifier");
+      _indirectSpecularModifier = serializedObject.FindProperty("indirectSpecularModifier");
+      _limitRefreshRate = serializedObject.FindProperty("limitRefreshRate");
+      _mipmapFilterMode = serializedObject.FindProperty("mipmapFilterMode");
+      _refreshRate = serializedObject.FindProperty("refreshRate");
+      _resolution = serializedObject.FindProperty("resolution");
+    }
+  }
+}

…P.VXGI.Runtime.ShaderStructs.asmdef.meta …tor/Looooong.SRP.VXGI.Editor.asmdef.metaRuntime/ShaderStructs/Looooong.SRP.VXGI.Runtime.ShaderStructs.asmdef.meta renamed to Editor/Looooong.SRP.VXGI.Editor.asmdef.meta Runtime/ShaderStructs/Looooong.SRP.VXGI.Runtime.ShaderStructs.asmdef.meta renamed to Editor/Looooong.SRP.VXGI.Editor.asmdef.meta

@@ -0,0 +1,11 @@
+using UnityEditor;
+using UnityEngine;
+
+namespace VXGIEditor {
+  [CustomEditor(typeof(VXGIMipmapDebug))]
+  public class VXGIMipmapDebugEditor : Editor {
+    public override void OnInspectorGUI() {
+      DrawDefaultInspector();
+    }
+  }
+}

Editor/VXGIEditor.cs

@@ -35,6 +35,62 @@ If you want to fiddle with the source code while using this package, you can [in
 
 For more information on how to manage UPM package, please refer to [this](https://docs.unity3d.com/Manual/upm-ui-actions.html).
 
+## Usage
+
+### Enable VXGI Render Pipeline
+
++ Goto `Asset/Rendering/VXGI Render Pipeline Asset` to create a new VXGI render pipeline asset.
++ Open **Project Settings** window by going to `Edit/Project Settings...`.
++ Assign the newly created render pipeline asset to `Graphics/Scriptable Render Pipeline Settings`.
+
+### Enable VXGI Rendering on a Camera
+
++ Add `VXGI` component to a Camera.
++ Assign tag `MainCamera` to the same Camera to preview VXGI rendering in Scene View.
++ *Optional:* Add `VXGI Mipmap Debug` to the same Camera to visualize the voxel mipmap volume.
+
+### Apply VXGI materials to objects in the Scene
+
+Apply the material that uses one of the following VXGI shaders:
+
++ `VXGI/Standard` and `VXGI/Standard (Specular setup)`
+  + Only `Albedo`, `Metallic`, `Specular`, `Smoothness`, `Normal Map` and `Emission` are supported.
++ `VXGI/Particles/Standard Unlit`
+  + Only `Additive` rendering mode is supported.
+
+### Light Sources
+
+Directional light, point light and spot light are supported. Lighting fall-off follows the inverse-squared distance model without range attenuation. The fall-off model will be expanded with more options in the future.
+
+## Configuration
+
+### VXGI Component Properties
+
++ **Voxel Volume**:
+  + **Follow Camera**: make the voxel volume center follow the camera position.
+  + **Center**: the center of the voxel volume in World Space.
+  + **Bound**: the size of the voxel volume in World Space.
+  + **Resolution**: the resolution of the voxel volume.
+  + **Anti Aliasing**: the anti-aliasing level of the voxelization process.
+  + **Mipmap Filter Mode**: specify the method to generate the voxel mipmap volume.
+  + **Limit Refresh Rate**: limit the voxel volume refresh rate.
+  + **Refresh Rate**: the target refresh rate of the voxel volume.
++ **Rendering**:
+  + **Indirect Diffuse Modifier**: how strong the diffuse cone tracing can affect the scene.
+  + **Indirect Specular Modifier**: how strong the specular cone tracing can affect the scene.
+  + **Diffuse Resolution Scale**: downscale the diffuse cone tracing pass.
+
+### VXGI Mipmap Debug Component Properties
+
++ **Mipmap Level**: Mipmap level to visualize.
++ **Ray Tracing Step**: how big is a step when ray tracing through the voxel volume.
++ **Filter Mode**: visualization filter mode.
+
+## Known Issues and Limitations
+
++ VXGI uses geometry shader, which is not supported by few graphics APIs, e.g., Metal.
++ The content of Unity UI element is not displayed in Scene View, but only bounding Rect Transform is displayed. Unity UI element is displayed normally in Game View.
+
 ## Contributing
 
 All pull requests are welcome.

Editor/VXGIEditor.cs.meta

@@ -1,15 +1,15 @@
 {
     "name": "Looooong.SRP.VXGI.Runtime",
     "references": [
-        "Unity.Postprocessing.Runtime",
-        "Looooong.SRP.VXGI.Runtime.ShaderStructs"
+        "Unity.Postprocessing.Runtime"
     ],
-    "optionalUnityReferences": [],
     "includePlatforms": [],
     "excludePlatforms": [],
     "allowUnsafeCode": false,
     "overrideReferences": false,
     "precompiledReferences": [],
     "autoReferenced": true,
-    "defineConstraints": []
+    "defineConstraints": [],
+    "versionDefines": [],
+    "noEngineReferences": false
 }