Home -> IRenderer -> Initialize

Description

The Initialize method must be called before any other methods on the IRenderer interface. It performs all the necessary initialization tasks which are required to prepare the renderer for the process of creating other objects, and producing renderered frames.

The supplied window system information structure identifies the native window system that the renderer will use. Applications normally create one of the platform-specific structures documented under PlatformBindings, such as WindowSystemInfoHeadless, WindowSystemInfoWin32, WindowSystemInfoWayland, or WindowSystemInfoAppKit.

Usage

SuccessToken Initialize(const WindowSystemInfoBase& windowSystemInfo, InitializationFlags flags = InitializationFlags::None);

Argument list

windowSystemInfo [WindowSystemInfoBase]
Information on the native window system the renderer will be bound to.
flags [InitializationFlags]
Optional flags to control the initialization process.

Return value

[SuccessToken]
True if the initialization process was successful, false otherwise. An assertion will be raised in debug builds if the result isn't tested.

See also