Manual: Integrating Unity into Windows applications (original) (raw)

Windows requirements and compatibility

You can use the Unity as a Library feature to integrate the Unity Runtime Library in Windows applications.

This feature enables you to include Unity-powered features in your application, such as:

• 3D/2D Real-Time Rendering
• ARAugmented Reality More info
  See in Glossary Experience
• 3D model interaction
• 2D mini-games

The Unity Runtime Library exposes controls to manage when and how to load, activate, and unload content within the application.

On Windows, you can embed a Unity build into your application in the following ways:

• Launch Unity as an external build from your application and specify a window in which Unity will initialize and render with the -parentHWND command line argument. This is the easier option.
• Embed Unity within your existing operating system process. To do this, call into UnityPlayer.dll, which any Win32 application can load directly. The entry point signature is:
  extern "C" UNITY_API int UnityMain(HINSTANCE hInstance, HINSTANCE hPrevInstance, LPWSTR lpCmdLine, int nShowCmd);

Use lpCmdLine to pass any command line arguments to Unity, for example, to control resolution, job threads or parent HWND. This enables you to run Unity within your process. For other valid Unity player command line arguments you can use, see Unity Standalone Player command line arguments.

Additional resources:

• Using Unity as a Library in other applications
• Unity Standalone Player command line arguments

• Unity as a Library added in 2019.3.

Windows requirements and compatibility