WebViewPrefab is a prefab that makes it easy to view and interact with an IWebView in 3D world space. It takes care of creating an IWebView, displaying its texture, and handling pointer interactions from the user, like clicking, dragging, and scrolling. So, all you need to do is specify a URL or HTML to load, and then the user can view and interact with it. For use in a Canvas, see CanvasWebViewPrefab instead.
There are two ways to create a WebViewPrefab:
If your use case requires a high degree of customization, you can instead create an IWebView outside of the prefab with Web.CreateWebView().
bool CursorIconsEnabled Determines whether the mouse cursor icon is automatically updated based on interaction with the web page. For example, hovering over a link causes the mouse cursor icon to turn into a pointer hand. The default is true. CursorIconsEnabled is currently only supported by 3D WebView for Windows and macOS.
See also: IWithCursorType
DragMode DragMode Determines how the prefab handles drag interactions.
This property is ignored when running in Native 2D Mode.
For information on the limitations of drag interactions on iOS and UWP, please see this article.
The Android Gecko package doesn't support the HTML Drag and Drop API (GeckoView limitation).
float DragThreshold Determines the threshold (in web pixels) for triggering a drag. The default is 20.
When the prefab's DragMode is set to DragToScroll, this property determines the distance that the pointer must drag before it's no longer considered a click.
When the prefab's DragMode is set to DragWithinPage, this property determines the distance that the pointer must drag before it triggers a drag within the page.
bool HoveringEnabled Determines whether hover interactions are enabled. The default is true.
This property is ignored when running in Native 2D Mode.
For information on the limitations of hovering on iOS and UWP, please see this article.
string InitialUrl If you drag a WebViewPrefab.prefab into the scene via the editor, you can set this property in the editor to make it so that the instance automatically loads the given URL after it initializes. To load a new URL at runtime, use IWebView.LoadUrl() instead.
See also: How to load local files
bool KeyboardEnabled Determines whether the webview automatically receives keyboard input from the native keyboard and the Keyboard prefab. The default is true.
bool LogConsoleMessages Determines whether JavaScript console messages from IWebView.ConsoleMessageLogged are printed to the Unity logs. The default is false.
bool NativeOnScreenKeyboardEnabled Determines whether the operating system's native on-screen keyboard is automatically shown when a text input in the webview is focused. The default for WebViewPrefab is false.
The native on-screen keyboard is only supported for the following packages:
3D WebView for Android with Gecko Engine doesn't support automatically showing the native on-screen keyboard, but you can use Unity's TouchScreenKeyboard API to show the keyboard and then send typed characters to the webview like described in this article.
float PixelDensity Sets the webview's pixel density, which is its number of physical pixels per logical pixel. The default value is 1, but increasing it to 2 can make web content appear sharper or less blurry on high DPI displays. PixelDensity is currently only supported by 3D WebView for Windows and macOS.
// Increase the pixel density to 2 for high DPI screens.
webViewPrefab.PixelDensity = 2;See also: IWithPixelDensity
bool RemoteDebuggingEnabled Determines whether the prefab enables remote debugging by calling Web.EnableRemoteDebugging(). The default is false.
float Resolution Gets or sets the prefab's resolution in pixels per Unity unit. You can change the resolution to make web content appear larger or smaller. The default resolution for WebViewPrefab is 1300.
Setting a lower resolution decreases the pixel density, but has the effect of making web content appear larger. Setting a higher resolution increases the pixel density, but has the effect of making content appear smaller. For more information on scaling web content, see this support article.
// Set the resolution to 1800px per Unity unit.
webViewPrefab.Resolution = 1800; bool ScrollingEnabled Determines whether scrolling is enabled. The default is true.
float ScrollingSensitivity Determines the scroll sensitivity. The default sensitivity for WebViewPrefab is 0.005.
bool Visible { get; set; }Gets or sets whether the instance is visible and responds to raycasts. The default is true. If you want to hide the webview, setting this property to false is often preferable to disabling the prefab's GameObject, because the latter stops the prefab's scripts from running, which may prevent it from initializating, for example.
IWebView? WebView { get; }Returns the prefab's IWebView instance, or null if the prefab hasn't finished initializing yet. To detect when the WebView property is no longer null, please use WaitUntilInitialized().
await webViewPrefab.WaitUntilInitialized();
// Now the WebView property is ready.
webViewPrefab.WebView.LoadUrl("https://vuplex.com"); Vector2 BrowserToScreenPoint(int xInPixels, int yInPixels) Converts the given point from web browser viewport coordinates to the corresponding Unity screen space coordinates of where the point is rendered in the application window. Note that web browser coordinates (the input parameters) treat the top left corner of the browser viewport as the (0, 0) origin. In contrast, Unity's screen space coordinates (the return value) treat the bottom left corner of the application's window as the (0, 0) origin.
var screenPoint = webViewPrefab.BrowserToSreenPoint(200, 300);
Debug.Log($"Point (200px, 300px) within the browser window is rendered at point {screenPoint} on the device screen."); void Destroy() Destroys the instance and its children. Note that you don't need to call this method if you destroy the instance's parent with Object.Destroy().
// The webview can no longer be used after it's destroyed.
webViewPrefab.Destroy();static WebViewPrefab Instantiate(float width, float height, WebViewOptions options) Like Instantiate(float, float, except it also accepts an object of options flags that can be used to alter the generated webview's behavior.
static WebViewPrefab Instantiate(float width, float height) Creates a new instance with the given dimensions in Unity units. The WebView property is available after initialization completes, which is indicated by WaitUntilInitialized() method. A WebViewPrefab's default resolution is 1300px per Unity unit but can be changed by setting Resolution property.
// Create a 0.5 x 0.5 instance
var webViewPrefab = WebViewPrefab.Instantiate(0.5f, 0.5f);
// Position the prefab how we want it
webViewPrefab.transform.parent = transform;
webViewPrefab.transform.localPosition = new Vector3(0, 0f, 0.5f);
webViewPrefab.transform.LookAt(transform);
// Load a URL once the prefab finishes initializing
await webViewPrefab.WaitUntilInitialized();
webViewPrefab.WebView.LoadUrl("https://vuplex.com");static WebViewPrefab Instantiate(IWebView webView) Like Instantiate(float, float), except it initializes the instance with an existing, initialized IWebView instance. This causes the WebViewPrefab to use the existing IWebView instance instead of creating a new one. This can be used, for example, to create multiple WebViewPrefabs that are connected to the same IWebView, or to create a prefab for an IWebView created by IWithPopups.PopupRequested.
await firstWebViewPrefab.WaitUntilInitialized();
var secondWebViewPrefab = WebViewPrefab.Instantiate(firstWebViewPrefab.WebView);
// TODO: Position secondWebViewPrefab to the location where you want to display it. void Resize(float width, float height) Resizes the prefab mesh and webview to the given dimensions in Unity units.
webViewPrefab.Resize(1.2f, 0.5f); void SetOptionsForInitialization(WebViewOptions options) Sets options that can be used to alter the webview that the prefab creates during initialization. This method can only be called prior to when the prefab initializes (i.e. directly after instantiating it or setting it to active).
using System;
using UnityEngine;
using Vuplex.WebView;
class SetOptions : MonoBehaviour {
// IMPORTANT: With this approach, you must set your WebViewPrefab or CanvasWebViewPrefab to inactive
// in the scene hierarchy so that this script can manually activate it. Otherwise, this
// script won't be able to call SetOptionsForInitialization() before the prefab initializes.
//
// TODO: Set this webViewPrefab field to the inactive WebViewPrefab or CanvasWebViewPrefab in your scene
// via the Editor's Inspector tab.
public BaseWebViewPrefab webViewPrefab;
void Awake() {
if (webViewPrefab.gameObject.activeInHierarchy) {
throw new Exception("The WebViewPrefab object is active in the Editor's scene view. Please set it to inactive so that this script can manually activate it.");
}
webViewPrefab.gameObject.SetActive(true);
webViewPrefab.SetOptionsForInitialization(new WebViewOptions {
preferredPlugins = new WebPluginType[] { WebPluginType.Android }
});
}
} void SetPointerInputDetector(IPointerInputDetector pointerInputDetector) By default, the prefab detects pointer input events like clicks through Unity's event system, but you can use this method to override the way that input events are detected.
var yourCustomInputDetector = webViewPrefab.Collider.AddComponent<YourCustomInputDetector>();
webViewPrefab.SetPointerInputDetector(yourCustomInputDetector); void SetWebViewForInitialization(IWebView webView) By default, the prefab creates a new IWebView during initialization. However, you can call this method before the prefab initializes to pass it an existing, initialized IWebView to use instead. This method can only be called prior to when the prefab initializes (i.e. directly after instantiating it or setting it to active).
Task WaitUntilInitialized() Returns a task that completes when the prefab is initialized, which means that its WebView property is ready for use.
await webViewPrefab.WaitUntilInitialized();
// Now the WebView property is ready.
webViewPrefab.WebView.LoadUrl("https://vuplex.com");See also: Initialized
Vector2 WorldToNormalized(Vector3 worldPoint) Converts the given world point to a normalized point in the webview.
EventHandler<ClickedEventArgs> Clicked Indicates that the prefab was clicked. Note that the prefab automatically calls IWebView.Click() for you.
webViewPrefab.Clicked += (sender, eventArgs) => {
Debug.Log("WebViewPrefab was clicked at point: " + eventArgs.Point);
}; EventHandler Initialized Indicates that the prefab finished initializing, so its WebView property is ready to use.
See also: WaitUntilInitialized()
EventHandler PointerEntered Indicates that the pointer (e.g. mouse cursor) entered the prefab.
EventHandler PointerExited Indicates that the pointer (e.g. mouse cursor) exited the prefab.
EventHandler<ScrolledEventArgs> Scrolled Indicates that the prefab was scrolled. Note that the prefab automatically calls IWebView.Scroll() for you.
webViewPrefab.Scrolled += (sender, eventArgs) => {
Debug.Log($"WebViewPrefab was scrolled. Point: {eventArgs.Point}, scroll delta: {eventArgs.ScrollDelta}");
};