[v1] Support single pass instancing for VR

[mob-sakai]

ref: #48 #79

• Generate two soft mask buffers for both eyes
• Selecting one of the soft mask buffers using unity_StereoEyeIndex variable.

  lerp(_leftEye, _rightEye, unity_StereoEyeIndex);

https://docs.unity3d.com/Manual/SinglePassInstancing.html

[maskedmouse]

How's the progress of this issue? If you want me to test the functionality, let me know. I've got an Oculus GO.

[mob-sakai]

@maskedmouse Thanks! So far no progress has been made...

[mob-sakai]

SoftMask_VRTest.zip

WIP: Experimental version with support for multi-pass, single-pass and single-pass instancing.

• Scene view is broken.
• 2 RenderTextures for soft mask buffer.
• The scripts are not optimized.
• single-pass instancing is not tested. (It doesn't support Mac)

Open Assets/VRTest.unity and build it.

To change render mode, select VR menu.

[maskedmouse]

I've tested it with Unity 2019.3.15 without success.

Just a few remarks:

• In 2019.3 the PlayerSettings.virtualRealitySupported is marked as deprecated but still functional.
• upgrading to 2019.3 some API got replaced automatically. Usually VRSettings => XRSettings
• I had to replace the Mock HMD with Oculus SDK. Which is logical because the Oculus GO doesn't work with a Mock HMD sdk.

I've made a screen capture of the result:

I noticed the stereo rendering mode for Oculus is Single Pass Multiview. In the future 2020.1+ the XR Management package must be used. Which also has 2 options, Multipass or Multiview. Which in our case would be Single Pass Multiview. I have tried the new XR Management package. But the result is the same.

For PC Oculus I cannot test right now (which can be Single Pass Instanced). I could test this later if you want.

[mob-sakai]

I don't know why Unity-chan are not displayed. Instead, gray rectangles are displayed... Are Unity-chans displayed in editor?

[mob-sakai]

Yes, the XR Management package should be supported in the future.

XR configuration in my environment:

BTW, does multi pass render mode work well?

[mob-sakai]

It seems to be working fine on my android device.

• Sony Xperia XZ
• Mock HMD
• Android 8.0
• Multi pass/Single pass with multi-view

[maskedmouse]

I don't know why Unity-chan are not displayed. Instead, gray rectangles are displayed... Are Unity-chans displayed in editor?

Yes they are displayed in the editor.

BTW, does multi pass render mode work well?

I've used the new XR Management SDK with Multipass and that seems to work.

If you need me to debug some specific values let me know.

[mob-sakai]

Please try this. SoftMaskUGUI-VR-2.zip

Open Assets/VRTest.unity and build it. The scene contains a non-soft-maskable image.

[maskedmouse]

Please try this. SoftMaskUGUI-VR-2.zip

Open Assets/VRTest.unity and build it. The scene contains a non-soft-maskable image.

The result is that the soft masked items are still gray squares. The regular non-soft-maskable image is displayed fine.

[mob-sakai]

Please try this. SoftMaskUGUI-VR-3.zip

• I noticed that UNITY_SAMPLE_SCREENSPACE_TEXTURE is unnecessary.

[maskedmouse]

I've updated to the LTS release 2019.4.0f1 The image is now totally gone.

I'm using the Android Logcat 1.2.0-preview package to read out the output logs. I notice there is an OpenGL error. Not sure if it is related to this. But it is worth mentioning. 2020/06/10 10:25:36.777 31818 31833 Error Unity OPENGL NATIVE PLUG-IN ERROR: GL_INVALID_OPERATION: Operation illegal in current state It might be a thing of 2019.4 though.

[mob-sakai]

Wow!

[mob-sakai]

OK, let's test another shader...

[mob-sakai]

SoftMaskUGUI-VR-4.zip

• A shader that maps the soft mask buffer and image UVs as rgb.

[maskedmouse]

I'm getting the exact same result as before. Image is not showing.

In editor it indeed shows the RGB values but on the Oculus GO nothing

[mob-sakai]

Oh, I was making a mistake! Please fix UI-Default-SoftMaskable.shader as following:

// line 101
//UNITY_DECLARE_SCREENSPACE_TEXTURE(_MainTex); // Comment out
sampler2D _MainTex; // ADD

If you comment out the same file in SoftMaskUGUI-VR-3.zip, it may work.

[maskedmouse]

That seems to do the trick!

I'll change it to the third iteration and test that one as well.

[maskedmouse]

Yeah awesome!

[mob-sakai]

👏👏👏👏

[mob-sakai]

OK, VR support is the next step:

• [ ] 1 soft mask buffer for both eyes
• [ ] Optimize the scripts
• [ ] Fix scene view

[maskedmouse]

I've received news about the Oculus GO no longer being supported after 4 december 2020. I've tested the Oculus Quest with the solution you've made and it works there as well. All that remains is the actual implementation of the solution into the package.

[mob-sakai]

:+1:

[maskedmouse]

I'm trying to get an Oculus Quest build ready but I'm uncertain whether the package could be used in the last state you've posted. It think it could be used, because it works in a release build. It is just not in an optimal state yet right? As you've listed you want to create a singular Buffer for both eyes (I guess to preserve memory as you require double the texture memory now) and optimizing the scripts.

The only bug that I can find is that the Game View without VR enabled the softmask is broken. Not a big issue for me since I have VR enabled all the time but might be worth noting. I'll be looking forward to the release of the feature. In the meanwhile, I guess I'll use the solution as is since it seems to work.

[mob-sakai]

:+1: :+1: :+1: :+1: :+1: :+1: :+1:

[mob-sakai]

WIP

[ruben-ivre]

I'm very interested on this too, any updates? I have access to plenty of VR devices, so let me know if you want to test anything.

[mob-sakai]

@ruben-ivre :+1:

[maskedmouse]

It seems like in Unity 2020.2.1 the SoftMask is broken again. Perhaps this is due to an Universal Render Pipeline update. Reverting back to Unity 2020.1.x and it works again.

[mob-sakai]

OMG😇

[maskedmouse]

Update: When creating a small reproduction project, it seems to work fine in the editor with the latest SoftMasking package (1.0.0-preview.14) & Universal Render Pipeline (10.2.2). But once it is built for the Oculus Quest (Android) it fails, same as before the fix. With the package version from here, in 2020.2 it doesn't work in either editor nor Quest.

[nagoya0]

Do you have any updates on this?

[mob-sakai]

Please try v2: https://github.com/mob-sakai/SoftMaskForUGUI/releases/tag/v2.0.0

• ⚙ Installation