Added documentation for new material options

Author: Christopher Remde

Unity_Test_Project/Assets/Editor/BumpUpPackageVersionAndCopySamples.cs

@@ -1,6 +1,6 @@
 {
   "dependencies": {
-    "com.buildingvolumes.geometry_sequence_player": "file:C:/Dev/Volcapture/Unity_Geometry_Sequence_Player/Geometry_Sequence_Player_Package",
+    "com.buildingvolumes.geometry_sequence_player": "file:../../Geometry_Sequence_Player_Package",
     "com.unity.ai.navigation": "2.0.9",
     "com.unity.analytics": "3.8.1",
     "com.unity.collab-proxy": "2.9.3",

Unity_Test_Project/Packages/manifest.json

@@ -1,7 +1,7 @@
 {
   "dependencies": {
     "com.buildingvolumes.geometry_sequence_player": {
-      "version": "file:C:/Dev/Volcapture/Unity_Geometry_Sequence_Player/Geometry_Sequence_Player_Package",
+      "version": "file:../../Geometry_Sequence_Player_Package",
       "depth": 0,
       "source": "local",
       "dependencies": {

Unity_Test_Project/Packages/packages-lock.json

@@ -15,7 +15,7 @@ EditorBuildSettings:
     path: Assets/Basic_Build_Sample_PC.unity
     guid: 6b09899ec332ee04eb46e280d0d6db69
   - enabled: 1
-    path: Assets/Samples/Geometry Sequence Player/1.1.0/Sequence Samples/02_Pointcloud_Example.unity
+    path: Assets/Samples/Geometry Sequence Player/1.2.0/Sequence Samples/02_Pointcloud_Example.unity
     guid: c8a284e921121b24fa1f675776339904
   m_configObjects: {}
   m_UseUCBPForAssetBundles: 0

Unity_Test_Project/ProjectSettings/EditorBuildSettings.asset

@@ -18,7 +18,7 @@ EditorUserSettings:
       value: 5553045f5d0c505e0e5d5f7015260f4413154c7c297a7e6029791965e6e26261
       flags: 0
     RecentlyUsedSceneGuid-4:
-      value: 0653030355045f0e5b59097012730d4441164828742a77327a794835b6e66d60
+      value: 000955545d010c025f5f5d7041210d441016492c7a7f73677a7f4e60bbb9646c
       flags: 0
     RecentlyUsedSceneGuid-5:
       value: 50520d5750535f5d0c5d0f7747710d4417161e7e747d2469297a4867e7b16268
@@ -27,22 +27,25 @@ EditorUserSettings:
       value: 54040c02515158595b0d0d7340735d44424f1d79757e70312e7b4a30e0b56d61
       flags: 0
     RecentlyUsedSceneGuid-7:
-      value: 57050c54500559090e5a097042765e4441164f2b792975312f2d4f6ab1b9306b
+      value: 0653030355045f0e5b59097012730d4441164828742a77327a794835b6e66d60
       flags: 0
     RecentlyUsedSceneGuid-8:
-      value: 000955545d010c025f5f5d7041210d441016492c7a7f73677a7f4e60bbb9646c
+      value: 57050c54500559090e5a097042765e4441164f2b792975312f2d4f6ab1b9306b
       flags: 0
     RecentlyUsedSceneGuid-9:
       value: 0207500300005c0d5a5a0d7b49250944141540722a2a73657d791b30e0b43268
       flags: 0
     UnityEditor.ShaderGraph.Blackboard:
-      value: 18135939215a0a5004000b0e15254b524c030a3f2964643d120d1230e9e93a3fd6e826abbd3c3e302a07a37e0901373ae01e0008f707250d171df81a53a5485d41895ac825e0100ec20313c0d91cddccd3d0c7efcca9bd80908fecb0f9cfddf1eff4e7a1b1eae482f0fdade8e1928b86d888ed909c968797a7cf
+      value: 18135939215a0a5004000b0e15254b524c030a3f2964643d120d1230e9e93a3fd6e826abbd2e2d293c4ead313b08042de6030a0afa240c0d020be94c4baf5e435d8715fa32c70d15d11612dacc11fee5d3c5d1fe9ab1bf968e93e2ffcbc3e7e2f0b3ffe0e8b0be9afbffaeffff8e85dd8390e3949c8899daa7
       flags: 0
     UnityEditor.ShaderGraph.FloatingWindowsLayout2:
-      value: 181344140043005e1a220d3b1f364b524c0c5a27130c293326201334cee5322ca0bd30e8eb293a707b0fd0180b3d0a36fc0d3d04e649500d1002ee0b5dbd1d2c27c00ad113cb1e10e41f1addc80993b98d9884a69ae6d8f0d1cda9e8fbfefaf9f9dea3fdb9ade882f0f7b0e1e380cafbf2c3adc18e9cd285a2908b82ec869c8395949c9483d68a8d97ddbd90bf
+      value: 181344140043005e1a220d3b1f364b524c0c5a27130c293326201334cee5322ca0bd30e8eb293a707b0fd0180b3d0a36fc0d3d04e649500d1002ee0b5dbd1d2c27c00ad113cb1e10e41f1addc80993b9848381a489b2be81868ef6aaada4bbaba4a2e9b9a797d4cfb8a6e4bea1d6c6c8eeccb1d7c9d28b9dea9c819ffcdeede0d0cc8094839c9ac39bd7f1ddf2def7e8d1b8e6ccc4f5c9e5cd8381af
       flags: 0
     UnityEditor.ShaderGraph.InspectorWindow:
-      value: 18135939215a0a5004000b0e15254b524c1119263f2d6a722016393ce1eb3d36e5d339f9a5602b2e2c07a37e0901373ae01e0008f707250d171df81a53a5485d41895ac825e0100ec20313c0d91cddccd3d0c7efcca9bd80908fecb0f9cfddf1eff4e7a1b1eae482f0fbafe0e1928b86d888ed969b928797a7cf
+      value: 18135939215a0a5004000b0e15254b524c030a3f2964643d120d1230e9e93a3fd6e826abbd2e2d293c4ead313b08042de6030a0afa240c0d020be94c4ba75e435d8715fa32c70d15d11612dacc11fee5d3c5d1fe9ab1b7968e93e2ffcbc3e7e2f0b3ffe0e8b0be9afbffaeffff8e85dd8390e59398889d97ea828387ea8286838f84d0cbc4
+      flags: 0
+    UnityEditor.ShaderGraph.ToggleSettings:
+      value: 18135d1527590858060c032302276919051e1a26296a7c362c250e36aea23d2bd2f533ffee3f280a3011e63e083b4365f40b0518f34748020227f31d01fa13071ed72ecc09c11d10ce5b46c8cc11c2e69994d7e5d4e4f5e8ccd0b6fbf0f5fcbaafb3f9d5a5a6f99ee8b2
       flags: 0
     vcSharedLogLevel:
       value: 0d5e400f0650

Unity_Test_Project/UserSettings/EditorUserSettings.asset

@@ -55,13 +55,13 @@ Unity Apps can run in three distinct modes on the Apple Vision Pro: A **flat 2D
 All modes are supported by this plugin. While the **flat mode** runs like an IPhone or IPad application, there are stark differences between the **bounded** and **immersive** mode.
 We generally recommended to use the **immersive** mode whenever you can, due to it's much higher performance capabilities.
 
-### Bounded mode
+### Bounded mode / Polyspatial
 
 The bounded mode lets the users run an app along other apps, inside a limited volume, comparable to a 3D window. Apps running in this mode face many restrictions, including not being able to render their content natively. Unity needs to translate all meshes, textures, materials and shaders to RealityKit equivalents, this is called the **PolySpatial** pipeline. Due to these restrictions, playback performance suffers and works only for smaller sequences. Pointclouds sequences should stay under **50.000 points per frame**, mesh sequences under **30.000 polygons per frame**, and textures at or under **2048x2048 texture resolution** per frame. Additionally, there might be a performance ditch when the sequence starts, especially for pointcloud sequences. These are gradually streamed in to not overload the system.
 
-Bounded mode should be detected automatically by the package. If it does not work and you get playback errors while running on the device, you need to have a volume camera component inside your scene.
+> ℹ️ If you want to use the bounded mode, make sure to set the **Pointcloud Render Path** in the **Geometry Sequence Stream** component to **PolySpatial**, even when you're playing back mesh sequences!
 
-> ☝️ Due to some lower level code in this package, the playback might not work correctly in the AVP simulator
+Due to some lower level code in this package, the playback might not work correctly in the AVP simulator
 
 ### Immersive mode
 

docs/content/docs/tutorials/distribution/index.md

@@ -68,14 +68,19 @@ Detailed explanation of all the settings and controls inside of the player and s
 
 ![All player settings](editor_playback_stream_component.png)
 
+**Material Settings:**
+
+- **Custom Material** If you want to apply your own material to the sequence, you can set it here. If this field is left empty, a default material will be loaded. This material needs to follow the [guidelines here](/Unity_Geometry_Sequence_Player/docs/tutorials/materials/)
+- **Instantiate Material**: Will only be shown when a custom material is set. With this option, you can control if the material should either be cloned. If it's cloned, changing the origin material in Assets won't effect the sequence material during play
+
 **Pointcloud Settings:** These settings only affect pointcloud based sequences.
 
+- **Point Render Path** Choose which playback path to use. For HDRP, URP and Built-In with Shadergraph installed, we recommend the ***Shadergraph*** path. Otherwise ***Legacy*** should be used.  
 - **Point Size:** Set the size of the individual points with the  modifier (in Unity units).
-- **Point Type:** Set the shape of the points. They can either be displayed as **Quads**, **Circles** or **Splats** (experimental, not recommended)**.
+- **Point Emission:** Set the emission strength of the points.
 
 **Mesh Settings:** These settings only affect mesh based sequences.
 
-- **Mesh Material:** Set an alternative material for your mesh sequence. If left empty, a default unlit material will be used.
 - **Material slots:** Set to which material slots the texture of your sequence should apply. Options are **Main texture**, **Emissive** and **Detail**
 - **Custom texture slots:** If the material should apply to other slots, add them here. Add the name of the texture slot as defined in the shader.