This page has been translated automatically.
Video Tutorials
Interface
Essentials
Advanced
How To
Professional (SIM)
UnigineEditor
Interface Overview
Assets Workflow
Working With Projects
Adjusting Node Parameters
Setting Up Materials
Setting Up Properties
Lighting
Sandworm
Using Editor Tools for Specific Tasks
Extending Editor Functionality
Built-in Node Types
Nodes
Objects
Effects
Decals
Light Sources
Geodetics
World Nodes
Sound Objects
Pathfinding Objects
Players
Programming
Fundamentals
Setting Up Development Environment
Usage Examples
C++
C#
UnigineScript
UUSL (Unified UNIGINE Shader Language)
Plugins
File Formats
Materials and Shaders
Rebuilding the Engine Tools
GUI
Double Precision Coordinates
API
Containers
Common Functionality
Controls-Related Classes
Engine-Related Classes
Filesystem Functionality
GUI-Related Classes
Math Functionality
Node-Related Classes
Objects-Related Classes
Networking Functionality
Pathfinding-Related Classes
Physics-Related Classes
Plugins-Related Classes
IG Plugin
CIGIConnector Plugin
Rendering-Related Classes
Content Creation
Content Optimization
Materials
Material Nodes Library
Miscellaneous
Input
Math
Matrix
Textures
Art Samples
Tutorials
Warning! This version of documentation is OUTDATED, as it describes an older SDK version! Please switch to the documentation for the latest SDK version.
Warning! This version of documentation describes an old SDK version which is no longer supported! Please upgrade to the latest SDK version.

Screen

This section contains screen settings such as VR emulation and stereo modes, virtual resolution, border, framerate stabilization etc.

Screen settings

Screen Settings
VR Emulation The value indicating the current VR emulation mode. One of the following values:
  • Disabled (by default)
  • HTC Vive
  • HTC Vive Pro
  • Oculus Rift

Console access: render_vr_emulation (API control)
Viewport Mode The viewport rendering mode. The following modes are available:
  • Default — default rendering mode.
  • Curved Panorama 180 — 180-degree panorama with curved edges.
  • Curved Panorama 360 — 360-degree panorama with curved edges.
  • Linear Panorama 180 — 180-degree linear panorama without distortion at the edges.
  • Linear Panorama 360 — 360-degree linear panorama without distortion at the edges.
  • Panorama Fisheye Orthographic — orthographic spherical panorama (fisheye) with an adjustable Field of View.
  • Panorama Fisheye Equidistant — equidistant (tru-theta or f-theta) spherical panorama (fisheye) with an adjustable Field of View.
  • Panorama Fisheye Stereographic — stereographic spherical panorama (fisheye) with an adjustable Field of View.
  • Panorama Fisheye Equisolid — equisolid (equal-area) spherical panorama (fisheye) with an adjustable Field of View.
  • Anaglyph — stereo mode that is viewed with red-cyan anaglyph glasses.
  • Interlaced — stereo mode that is used with interlaced stereo monitors and polarized 3D glasses.
  • Horizontal — horizontal stereo mode.
  • Vertical — vertical stereo mode.
Notice
If the panoramic rendering is enabled, underwater shafts and water line effects will be disabled.
Option #1 is selected by default (see above).
Console access: render_viewport_mode (API control)
Panorama Fisheye Fov The Field of View (in degrees) for the panoramic viewport mode selected at the moment.
Notice
Available only when the viewport rendering mode is set to one of the fisheye panorama modes (5-8).

Range of values: [0, 360]. The default value is 0.
Console access: render_panorama_fisheye_fov (API control)
Border Width Width of the image border (in pixels), to be rendered outside the horizontal bounds of the screen to reduce artefacts of post effects.
Border Height Height of the image border (in pixels), to be rendered outside the vertical bounds of the screen to reduce artefacts of post effects.
Max FPS The maximum FPS value, to which rendering FPS is to be clamped.
0 - disables FPS clamping. Both VSync, and Max FPS are actually about an additional idle period at the end of the frame. In case of VSync the Engine shall wait for the monitor to draw the whole image, while Max FPS enables you to specify any value for the delay (even a fractional, like 24.5). This clamping limit can be used for both debugging purposes and in the final build as well enabling you to smooth an unstable "jigsaw" framerate. For example, in case FPS jumps between 45 and 90, setting Max FPS to 45 may significantly improve your application's response visually.
Range of values: [0.0f, inf]. The default value is 0.0f.
Console access: render_max_fps (API control)
Virtual Resolution Width Width of the virtual screen (in pixels). This option can be used to render video with high resolution (e.g. 8K) regardless of monitor's resolution.
Virtual Resolution Height Height of the virtual screen (in pixels). This option can be used to render video with high resolution (e.g. 8K) regardless of monitor's resolution.
Last update: 2022-10-10
Build: ()