Engine Preferences
Predict Menu
The Predict menu offers an access to all the main Predict Unity functionalities :
Game Overlay : all the functionalities referring to the engine overlay, see the Interface Overview for more details on the overlay workflow,
Overlay/Enabled : enables/disables the Predict Engine overlay in the Game view when the application is on,
Overlay/Interactive Settings : opens a window to access all interactive settings for the Predict Engine overlay, see the Runtime scene edition section for more details,
Overlay/Reload : **Play mode only** reloads the Predict Engine scene for the overlay, see the Runtime scene edition section for more details,
Overlay/Save Simulation : **Play mode only** saves the current render from the Predict Engine overlay, see the Outputs section for more details,
Batch Render : open the Batch Renderer window, see the Outputs section for more details,
Engine View : opens the Predict Engine renderer window, see the Interface Overview for more details on the renderer view workflow,
Interface Preferences
The Engine Interface section offers some options on how the Predict Engine interface works :
General :
Auto Reload : if true, the Predictive Engine scene will be automatically reloaded when a change is detected in the Unity scene (interactive changes don't require a scene reload and won't be affected by this option),
Refresh Rate : defines how often the Predictive Engine simulation is updated on screen. This is only an interface option and it does not affect the actual Predictive Engine renderer : the renderer is continuously computing the simulation in the background. If the refresh rate is set to 0, the render will be updated at the maximum rate possible,
Maximum Resolution : Unity and the Predict Engine communicate via a shared memory, the shared memory is a memory block in which both the Predict Engine and Unity can share data, settings, and most importantly the Predict Engine render. By default, the space allowed for the Predict Engine texture can contain a 8K texture (7680x4320 pixels) : you can change the size of this space in the Interface preferences. If you try to load a texture larger than this resolution, a smaller texture with the same ratio will be created to fit in the shared memory.
Overlay :
Limit to one render at a time : if true, only one of the cameras enabled in the scene will be loaded for Predictive Engine, this option may be hidden if your license does not support Stereo and Multi-views,
Notify unloaded cameras : if true, a notification will appear on each camera that is not loaded for Predictive Engine,
Pause Engine on Unity Pause : if true, the Predictive Engine renderer will be paused/resumed when the Unity application is paused/resumed,
Overlay Mode : defines when the overlay is displayed on screen, depending on the selected mode, additional fields can be displayed bellow, see the Runtime scene edition section for more details,
Deployment :
The "Deploy ∽Engine with the Application" toggle defines whether the Predict Engine renderer should be deployed with the Application, see the Deployment section for more details,
Performances
The Performances section contains details on the performance optimizations for Predict Engine.
The "Optimize overlay GPU memory management" option is an optimization to reduce the GPU memory taken by Unity when using the Game mode. It can be useful if you encounter memory issues or slow refresh rate in the application while using the Predict overlay.
The "Start Engine process in the background" option is an optimization to start the Predict Engine process as a background process. This can be useful especially in built application, to make the application more reactive. Be careful, when the Predict Engine application runs in the background, verbose cannot be sent back to Unity and errors are no longer detected : if the process stops for any reason, Unity will not be informed.
We provide some default presets to run Predict Engine faster (less noisy) but with some inaccuracy, or slower but completely accurate. These presets are ranked from the fastest to the more accurate and can be selected using the Fast <--> Accurate slider in the Engine view or in the overlay interactive settings.
You can also define your own presets with custom performance settings : these settings are detailed in the Performance Settings section.
If you defined custom presets, you can pick one of those presets by changing the performance mode to Custom in the Engine view or in the overlay interactive settings.
Default Engine Settings
Scenes
The Predict Engine scenes require a few additional settings that you cannot define within the default Unity scenes. You can define these settings by placing a Scene Settings component anywhere in your scene : see the Scenes section for more details.
If you did not place an UVR Scene Settings component in your scene, default settings will be used. These default settings can be defined in the Engine Settings section of the preferences. See the Scenes section for more details on the settings.
Cameras
Cameras in Predict Engine require additional settings that you cannot define with the default Unity "Camera" component. You can define these settings with an UVR Camera Settings component : see the Sensors section for more details.
If you did not add the UVR Camera Settings component to an active camera in the scene, default settings will be used. These default settings can be defined in the Engine Settings section of the preferences. See the Sensors section for more details on the settings.
Profiler
The Engine profiler section contains the list of all processes currently rendering. See the Troubleshooting section for details on the details of each process.
