Merge branch 'feature/headless' into 'master'

Headless

See merge request voltstro-studios/uwb/unitywebbrowser!16

Author: Voltstro

docs/articles/toc.yml

@@ -23,6 +23,8 @@
       href: user/javascript.md
     - name: Client Events
       href: user/events.md
+    - name: Runtime Creation
+      href: user/runtime.md
     - name: Player Build
       href: user/player-build.md
 

docs/articles/user/runtime.md

@@ -0,0 +1,16 @@
+# Runtime Creation
+
+The <xref:VoltstroStudios.UnityWebBrowser.Core.WebBrowserClient> can be created manually at runtime without the usage of <xref:VoltstroStudios.UnityWebBrowser.WebBrowserUIBasic> or <xref:VoltstroStudios.UnityWebBrowser.WebBrowserUIFull>.
+
+When instantiating the class, you will need to set all required properties yourself.
+
+> [!NOTE]
+> <xref:VoltstroStudios.UnityWebBrowser.Communication.CommunicationLayer> and <xref:VoltstroStudios.UnityWebBrowser.Core.Engines.Engine> objects are Unity's [ScriptableObject](https://docs.unity3d.com/2021.3/Documentation/Manual/class-ScriptableObject.html). The associated properties on <xref:VoltstroStudios.UnityWebBrowser.Core.WebBrowserClient> must be set to a ScriptableObject instance, or created at runtime through the [`ScriptableObject.CreateInstance()`](https://docs.unity3d.com/2021.3/Documentation/ScriptReference/ScriptableObject.CreateInstance.html) method.
+
+There is a sample script that creates everything including the canvas, the <xref:VoltstroStudios.UnityWebBrowser.Core.WebBrowserClient.engine>, the <xref:VoltstroStudios.UnityWebBrowser.Core.WebBrowserClient.communicationLayer> and the <xref:VoltstroStudios.UnityWebBrowser.Core.WebBrowserClient> instance it self. You can import the script straight into your Unity project via the sample sections of the UWB package, or you can [view the script in GitHub](https://github.com/Voltstro-Studios/UnityWebBrowser/blob/master/src/Packages/UnityWebBrowser/Samples~/Runtime/Scripts/UWBRuntime.cs).
+
+## Headless Mode
+
+<xref:VoltstroStudios.UnityWebBrowser.Core.WebBrowserClient> constructor includes a `headless` parameter. When set to `true`, UWB will run in headless mode.
+
+Headless mode will not create a <xref:VoltstroStudios.UnityWebBrowser.Core.WebBrowserClient.BrowserTexture>, and it will not run UWB's internal pixel data thread. All other methods that the <xref:VoltstroStudios.UnityWebBrowser.Core.WebBrowserClient> has are available.

src/Packages/UnityWebBrowser/Runtime/Core/WebBrowserClient.cs

@@ -203,7 +203,8 @@ public Resolution Resolution
         public bool ignoreLogProcessJsonErrors = false;
 
         /// <summary>
-        ///     Texture that the browser will paint to
+        ///     Texture that the browser will paint to.
+        ///     <para>In headless mode this will be null</para>
         /// </summary>
         public Texture2D BrowserTexture { get; private set; }
 
@@ -294,6 +295,8 @@ public IWebBrowserLogger Logger
 
         #endregion
 
+        private bool headless;
+        private bool hasInitialized;
         private EngineProcess engineProcess;
         private WebBrowserCommunicationsManager communicationsManager;
         private CancellationTokenSource cancellationSource;
@@ -302,16 +305,33 @@ public IWebBrowserLogger Logger
         private NativeArray<byte> textureData;
         internal NativeArray<byte> nextTextureData;
 
-        internal WebBrowserClient()
+        /// <summary>
+        ///     Creates a new <see cref="WebBrowserClient"/> instance
+        /// </summary>
+        /// <param name="headless">
+        ///     Creates the browser client in headless mode.
+        ///     Headless mode will not create a <see cref="BrowserTexture"/> for you to use
+        /// </param>
+        public WebBrowserClient(bool headless = false)
         {
+            this.headless = headless;
         }
 
         /// <summary>
-        ///     Inits the browser client
+        ///     Inits the browser client.
+        ///     In normal operation you do not need to call this method.
         /// </summary>
         /// <exception cref="FileNotFoundException"></exception>
-        internal void Init()
+        /// <exception cref="InitializationException"></exception>
+        public void Init()
         {
+            //Initialized check
+            if (hasInitialized)
+                throw new InitializationException("The browser client has already been initialized!");
+
+            hasInitialized = true;
+            
+            //OS support check
             if (!WebBrowserUtils.IsRunningOnSupportedPlatform())
             {
                 logger.Warn("UWB is not supported on the current runtime platform! Not running.");
@@ -335,14 +355,16 @@ internal void Init()
             communicationLayer.IsInUse = true;
 
             //Setup texture
-            BrowserTexture = new Texture2D((int)resolution.Width, (int)resolution.Height, TextureFormat.BGRA32, false,
-                false);
-            WebBrowserUtils.SetAllTextureColorToOne(BrowserTexture, backgroundColor);
-
-            resizeLock = new object();
-            textureData = BrowserTexture.GetRawTextureData<byte>();
-            nextTextureData = new NativeArray<byte>(textureData.ToArray(), Allocator.Persistent);
-
+            if (!headless)
+            {
+                BrowserTexture = new Texture2D((int)resolution.Width, (int)resolution.Height, TextureFormat.BGRA32, false,
+                    false);
+                WebBrowserUtils.SetAllTextureColorToOne(BrowserTexture, backgroundColor);
+                resizeLock = new object();
+                textureData = BrowserTexture.GetRawTextureData<byte>();
+                nextTextureData = new NativeArray<byte>(textureData.ToArray(), Allocator.Persistent);
+            }
+            
             string browserEngineMainDir = WebBrowserUtils.GetAdditionFilesDirectory();
 
             //Start to build our arguments
@@ -418,11 +440,6 @@ internal void Init()
                 argsBuilder.AppendArgument("ignore-ssl-errors-domains", string.Join(",", ignoreSslErrorsDomains));
             }
 
-            //Make sure not to include this, its for testing
-#if UWB_ENGINE_PRJ //Define for backup, cause I am dumb as fuck and gonna accidentally include this in a release build one day 
-            //argsBuilder.AppendArgument("start-delay", 2000);
-#endif
-
             //Disable sandbox
             if (noSandbox)
             {
@@ -542,6 +559,10 @@ internal async UniTaskVoid EngineReady()
                     }
                 }
 
+                //Create pixel data loop in headless mode
+                if(headless)
+                    return;
+                
                 Thread pixelDataLoopThread = new(PixelDataLoop)
                 {
                     Name = "UWB Pixel Data Loop Thread"
@@ -955,17 +976,20 @@ public void Resize(Resolution newResolution)
         {
             CheckIfIsReadyAndConnected();
 
-            lock (resizeLock)
+            if (!headless)
             {
-                BrowserTexture.Reinitialize((int)newResolution.Width, (int)newResolution.Height);
-                textureData = BrowserTexture.GetRawTextureData<byte>();
-                communicationsManager.Resize(newResolution);
+                lock (resizeLock)
+                {
+                    BrowserTexture.Reinitialize((int)newResolution.Width, (int)newResolution.Height);
+                    textureData = BrowserTexture.GetRawTextureData<byte>();
 
-                nextTextureData.Dispose();
-                nextTextureData = new NativeArray<byte>(textureData.ToArray(), Allocator.Persistent);
-                communicationsManager.pixelsEventTypeReader.SetPixelDataArray(nextTextureData);
+                    nextTextureData.Dispose();
+                    nextTextureData = new NativeArray<byte>(textureData.ToArray(), Allocator.Persistent);
+                    communicationsManager.pixelsEventTypeReader.SetPixelDataArray(nextTextureData);
+                }
             }
-
+            
+            communicationsManager.Resize(newResolution);
             logger.Debug($"Resized to {newResolution}.");
         }