com.unity.polyspatial.visionos@1.3.9

## [1.3.9] - 2024-08-26

### Changed
- We have narrowed down the conditions under which the package will compile from UNITY_VISIONOS || UNITY_IOS || UNITY_EDITOR_OSX to (UNITY_VISIONOS || UNITY_IOS) && UNITY_EDITOR_OSX.  This should eliminate compile errors in the case where you had the OSX editor but not the visionOS or iOS platform dependencies.

### Fixed
- Wrap all MonoPInvokeCallback methods in try/catch to avoid potential crashes in player builds.
- Parent SkinnedMeshRenderer bones to parent of the RootBone (so that it's a sibling with the RootBone) rather than to the SkinnedMeshRenderer itself - this fixes an issue where the RootBone was on a different hierarchy than the SkinnedMeshRenderer, and changes applied to the RootBone GameObject didn't affect the bones.

Author: Unity Technologies

CHANGELOG.md

@@ -9,6 +9,15 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 For general changes to PolySpatial, refer to the [PolySpatial Changelog](https://docs.unity3d.com/Packages/com.unity.polyspatial@latest?subfolder=/changelog/CHANGELOG.html).
 
+## [1.3.9] - 2024-08-26
+
+### Changed
+- We have narrowed down the conditions under which the package will compile from UNITY_VISIONOS || UNITY_IOS || UNITY_EDITOR_OSX to (UNITY_VISIONOS || UNITY_IOS) && UNITY_EDITOR_OSX.  This should eliminate compile errors in the case where you had the OSX editor but not the visionOS or iOS platform dependencies.
+
+### Fixed
+- Wrap all MonoPInvokeCallback methods in try/catch to avoid potential crashes in player builds.
+- Parent SkinnedMeshRenderer bones to parent of the RootBone (so that it's a sibling with the RootBone) rather than to the SkinnedMeshRenderer itself - this fixes an issue where the RootBone was on a different hierarchy than the SkinnedMeshRenderer, and changes applied to the RootBone GameObject didn't affect the bones. 
+
 ## [1.3.1] - 2024-07-09
 
 ## [1.3.0] - 2024-06-26

Documentation~/Glossary.md

@@ -9,7 +9,9 @@ uid: psl-vos-glossary
 
 - **Unity PolySpatial -- Apple visionOS support** (com.unity.polyspatial.visionos): Adds a new build target (visionOS) and platform support for visionOS and Apple Vision Pro.
 
-- **PolySpatial App** (aka **Client App** or **Unity App**): A Unity app (Unity player) that uses PolySpatial. PolySpatial apps are split in two logical parts: the **Unity Sim** and the **Backend**. 
+- **PolySpatial App** (aka **Client App** or **Unity App**): A Unity app (Unity player) that uses PolySpatial. PolySpatial apps are split in two logical parts: the **Unity Sim** and the **Backend**.
+
+- **Apple visionOS XR Plug-in** (com.unity.xr.visionos): Implements XR Subsystems and includes common settings for visionOS apps like **App Mode** and **Immersion Style**. This is the only package required for immersive XR apps that use Metal to render.
 
 - **Unity Sim**: The non-rendering portion of a Unity app - its application-specific logic, as well as built-in simulation features including physics, animation, AI, and asset management.
     - **(Unity) Sim Space**: The world space of a Unity Sim. While a typical Unity app simulates and renders objects in the same space, these may differ in a PolySpatial app.
@@ -31,3 +33,9 @@ uid: psl-vos-glossary
 - **Exclusive Mode**: Refers to the runtime behavior where an app is the only active and visible application
 
 - **Shared Mode**: Refers to the runtime behavior where other apps may be active and/or visible
+
+- **Immersion Style**: Defines the behavior of fully immersive content when using a `VolumeCamera` whose output mode is `Unbounded` or `VR`. This can be set at build time under `Project Settings > XR Plug-in Management > Apple visionOS`. There are two settings for Immersion Style, one for MR and one for VR, and they can be set independently. See [Apple's documentation](https://developer.apple.com/documentation/swiftui/immersionstyle) for more information. The options for Immersion Style are:
+    - Automatic: The default immersion style. It is equivalent to to Mixed.
+    - Full: Displays unbounded content that completely replaces passthrough.
+    - Mixed: Displays unbounded content mixed with passthrough.
+    - Progressive: Displays unbounded content that partially replaces passthrough.

Documentation~/Resources/xcode-1.png

@@ -29,7 +29,7 @@ Global values must be set in C# using the methods of [PolySpatialShaderGlobals](
 Note that visionOS materials do not support global properties natively, and thus PolySpatial must apply global properties separately to all material instances, which may affect performance.  For animation, consider using the `PolySpatial Time` node rather than the standard Unity shader graph `Time`.  While `PolySpatial Time` will not be exactly synchronized with [Time.time](https://docs.unity3d.com/ScriptReference/Time-time.html) (notably, it will not reflect changes to [Time.timeScale](https://docs.unity3d.com/ScriptReference/Time-timeScale.html)), it is supported natively in visionOS and does not require per-frame property updates.
 
 ## Supported targets
-The `Universal` and `Built-In` targets are supported for conversion.  For both targets, the `Lit` and `Unlit` materials are supported, as well as the `Opaque` and `Transparent` surface types and the `Alpha Clipping` setting.  For `Transparent` surfaces, the `Alpha`, `Premultiply`, and `Additive` blending modes are supported.  No other target settings are currently supported for conversion.  Due to platform limitations, all materials will have `Front` render face, depth writes enabled, `LEqual` depth testing, and tangent space fragment normals.
+The `Universal` and `Built-In` targets are supported for conversion.  For both targets, the `Lit` and `Unlit` materials are supported (`Sprite Unlit` is treated the same as `Unlit`), as well as the `Opaque` and `Transparent` surface types and the `Alpha Clipping` setting.  For `Transparent` surfaces, the `Alpha`, `Premultiply`, and `Additive` blending modes are supported.  No other target settings are currently supported for conversion.  Due to platform limitations, all materials will have `Front` render face, depth writes enabled, `LEqual` depth testing, and tangent space fragment normals.
 
 ## MaterialX keyword
 The built-in `MaterialX` keyword may be used to select different paths to use for Unity rendering (as used in editor play mode) versus MaterialX export (as used on visionOS).  This is useful in cases where, for example, the Unity path requires Custom Function nodes that use HLSL beyond what is supported by the [MaterialX exporter](CustomFunctionNode.md).  Connect the Unity path to the `Off` keyword input and the MaterialX path to the `On` input.

Documentation~/Resources/xcode-2.png

@@ -3,11 +3,11 @@ uid: psl-vos-sorting-group
 ---
 # visionOS Sorting Groups
 
-The **VisionOS Sorting Group** component provides a way to use the visionOS platform's native sorting group capabilities. By placing renderers in a sorting group, you can get fine-grained control over which render is drawn first. While 2D components (such as SpriteRenderers and CanvasRenderers) have their own sorting mechanism, in some situations, it might help to override their sorting, or to sort non-2D renderers such as `MeshRenderers`.
+The **VisionOS Sorting Group** component provides a way to use the visionOS platform's native sorting group capabilities. By placing renderers in a sorting group, you can get fine-grained control over which renderer is drawn first. While 2D components (such as SpriteRenderers and CanvasRenderers) have their own sorting mechanism, in some situations, it might help to override their sorting, or to sort non-2D renderers such as `MeshRenderers`.
 
 A visionOS sorting group can also be used to sort input on visionOS, in the same way renderers would be sorted. Game objects with colliders can be rearranged using a sorting group - colliders with higher order will capture input and block any lower order colliders from receiving input. Note that the physics of these colliders are not altered - the sorting group only affects the collider with respect to input resolution.
 
-Any 2D renderers included in the `VisionOSSortingGroup` will have their default (sprite/canvas) sorting overridden. Each renderer can only belong to one sorting group at a time, and subsequent attempts to add a renderer to another sorting group will result in a warning.
+Any 2D renderers or particle systems included in the `VisionOSSortingGroup` will have their default (sprite/canvas) sorting overridden. Each renderer can only belong to one sorting group at a time, and subsequent attempts to add a renderer to another sorting group will result in a warning.
 
 To create a sorting group, add a **VisionOS Sorting Group** component to a GameObject in the scene. You can only add one **VisionOS Sorting Group** component per GameObject. You should avoid changing the component properties often -- changing these properties can be an expensive operation, especially if the **Apply To Descendants** option is enabled.
 

Documentation~/ShaderGraph.md

@@ -7,7 +7,7 @@ PolySpatial transfers WebCamTextures to host platforms using an optimized path.
 By default, Unity does not enable WebCamTexture support. You must create a scripting define named `POLYSPATIAL_ENABLE_WEBCAM` to use, and make sure that you fill out the `Camera Usage Description` field in `Player Settings > Other settings`. If you don't do this, then you will see errors with `LocalAssetManager` as it doesn't know how to deal with asset types it doesn't know about.
 
 ## Platform Support
-Support for WebCamTextures is dependent on the underlying API support on the target platform. This support may vary and might be entirely missing so take care to validate your needs on the platforms you wish to run on.
+On the Apple Vision Pro, WebCamTexture provides a feed of the user's Spatial Persona. In general, support for WebCamTextures is dependent on the underlying API support on the target platform. This support may vary and might be entirely missing so take care to validate your needs on the platforms you wish to run on.
 
 ## Texture updates and manual dirtying
 WebCamTextures are not auto dirtied when the camera updates the texture. This means that PolySpatial will not know that it needs to update the texture on the target host platform unless told. You can do this by using the `Unity.PolySpatial.PolySpatialObjectUtils.MarkDirty(webCamTexture)` on every frame (Usually in Update) in which the WebCamTexture is being changed while playing.
@@ -34,6 +34,6 @@ public class SetWebCamDirty : MonoBehaviour
 }
 ```
 
-This dirtying API, as with all if the WebCamTextureSupport, is on available when `POLYSPATIAL_ENABLE_WEBCAM` is defined.
+This dirtying API, as with all if the WebCamTextureSupport, is only available when `POLYSPATIAL_ENABLE_WEBCAM` is defined.
 
 

Documentation~/SortingGroup.md

@@ -1,4 +1,4 @@
-#if UNITY_VISIONOS || UNITY_IOS || UNITY_EDITOR_OSX
+#if (UNITY_VISIONOS || UNITY_IOS || POLYSPATIAL_INTERNAL) && (UNITY_EDITOR_OSX || UNITY_EDITOR_WIN)
 using System;
 using System.Diagnostics;
 using System.IO;

Documentation~/WebCamTextures.md

@@ -1,4 +1,4 @@
-#if UNITY_VISIONOS || UNITY_IOS || UNITY_EDITOR_OSX
+#if (UNITY_VISIONOS || UNITY_IOS || POLYSPATIAL_INTERNAL) && (UNITY_EDITOR_OSX || UNITY_EDITOR_WIN)
 #if POLYSPATIAL_INTERNAL
 using System;
 using System.Diagnostics;

Editor/BuildUtils.cs

@@ -1,4 +1,4 @@
-#if UNITY_EDITOR_OSX
+#if (UNITY_VISIONOS || UNITY_IOS || POLYSPATIAL_INTERNAL) && UNITY_EDITOR_OSX
 using System;
 using System.IO;
 using Unity.PolySpatial.Internals.Editor;