IWebBrowserSingleton::CreateBrowserWindow

Create a new web browser window

Windows
MacOS
Linux

Deprecated

  • Please use the new overload that takes a settings struct.

References

Module

WebBrowser

Header

/Engine/Source/Runtime/WebBrowser/Public/IWebBrowserSingleton.h

Include

#include "IWebBrowserSingleton.h"

Syntax

TSharedPtr< IWebBrowserWindow > CreateBrowserWindow
(
    void * OSWindowHandle,
    FString InitialURL,
    bool bUseTransparency,
    bool bThumbMouseButtonNavigation,
    TOptional< FString > ContentsToLoad,
    bool ShowErrorMessage,
    FColor BackgroundColor,
    int BrowserFrameRate,
    const TArray< FString > & AltRetryDomains
)

Remarks

Create a new web browser window

Returns

New Web Browser Window Interface (may be null if not supported)

Parameters

Parameter

Description

OSWindowHandle

Handle of OS Window that the browser will be displayed in (can be null)

InitialURL

URL that the browser should initially navigate to

bUseTransparency

Whether to allow transparent rendering of pages

ContentsToLoad

Optional string to load as a web page

ShowErrorMessage

Whether to show an error message in case of loading errors.

BackgroundColor

Opaque background color used before a document is loaded and when no document color is specified.

BrowserFrameRate

The framerate of the browser in FPS

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss