This page has been translated automatically.
Click here to view the original English version instead.
Getting Started
What's Inside?
Project Workflow
Migrating to Unigine
Migrating to Unigine From UnrealEngine
Migrating to Unigine From Unity
Programming Quick Start
1. Basic Scene Objects and Coordinate System
2. Logging and Printing Messages to Console
3. Saving and Loading a World
4. Closing the Application
5. Working with Smart Pointers
6. Creating and Deleting Nodes at Runtime
7. Creating and Setting Up a Camera
8. Creating and Setting up Light Sources
9. Creating, Applying and Deleting Materials at Runtime
10. Managing Existing Scene Objects
11. Performing Basic Transformations (Move, Rotate, Scale)
12. Making It in Time
13. Managing Intersections
14. Getting and Managing User Inputs
15. Implementing Game Logic and Using Properties
16. Creating User Interface
System Requirements
Principles of Operation
Virtual World Structure
World Management
Properties
Hierarchy and Inheritance
Custom Component System
Rendering
Rendering Sequence
Scattering
PSSM
Temporal Anti-Aliasing
Alpha Blending
Physics
Shapes
Collision Detection
Joints
Simulation of Physics
Bit Masking
Import System
File System
SDK Browser
Projects
Licenses
Add-Ons
Kinect2 Add-On
Tutorials Content Add-On
Vegetation Add-On
VRPN Add-On
UnigineEditor
Interface Overview
Layout Customization
Assets Workflow
Asset Types
Assets and Runtime Files
Organizing Assets
Copying Assets From Other Projects
Project Files
Version Control
Settings and Preferences
Editor Hotkeys
Global Physics Settings
Global Sound Settings
Working With Projects
Managing Worlds
Scene Navigation
Creating and Importing Nodes
Selecting and Positioning Nodes
Organizing Nodes
Exporting Nodes
Instancing Nodes
Adjusting Node Parameters
Transformation and Common Parameters
Visual Representation
Properties
Physics
Setting Up Materials
Organizing Materials
Setting Up Properties
Organizing Properties
Setting Up Cameras
Using Visual Helpers
System Menu
Landscape Tool
Creating a Terrain
Creating a Geo-Referenced Terrain
Generating Detail Masks
Generating Vegetation
Generating Spline Objects
Generating Vector Objects
Generating Point Objects
Generating Buildings
Procedural Refinement
Distributed Computing
Using Editor Tools for Specific Tasks
Capturing Screenshots and Frame Sequences
Adding Variations for a More Realistic Environment
Manual Terrain Modification
Mask Editor for Grass and Clutters
Bake Lighting
FAQ
Switching From the Previous Version of the Editor
Tools
Plugins for 3D Editors
Plugins for 3ds Max
Plugins for Maya
Performance Profiling Tools
Performance Profiler
Microprofile
ResourceEditor
MeshViewer
NormalCombiner
NormalMapper
AmbientMapper
AlphaMapper
ImageDDS
ImageTTF
USC Interpreter
Tileset File
Archiver
Resource
MeshImport
Upgrade Script
Built-in Node Types
Nodes
Node
Node Reference
Dummy Node
Layer
Pivot
Trigger
Objects
Dummy Object
Static Mesh
Skinned Mesh
Dynamic Mesh
Mesh Cluster
Mesh Clutter
Text Object
Sky
Cloud Layer
Effects
Particle System
Decals
Projected Decal
Orthographic Decal
Mesh Decal
Light Sources
Light Sources Parameters
Omni Light
Projected Light
World Light
Environment Probe
Voxel Probe
Geodetics
Geodetic Pivot
World Objects
World Layer
Sector
Portal
World Trigger
World Cluster
World Clutter
Switcher
World Expression
Sound Objects
Sound Source
Sound Reverb
Pathfinding Objects
Players
Player Actor
Player Dummy
Player Persecutor
Player Spectator
Programming
Fundamentals
Programming Overview
Engine Architecture
Typical Architecture of a Unigine-Based Application
Memory Management
Accessing Nodes and Files via Properties
Matrix Transformations
Setting Up Development Environment
Windows Development Environment
Linux Development Environment
Usage Examples
Custom Component System
Basic Object Movements
Creating and Attaching a Cloth
Creating a Car with Suspension Joints
Creating Mirrors Using Viewports (Rendering to Texture) or Materials
A Simple Mechanism Using Joints
Creating Routes
Creating Pylons and Wires Using Ropes
Dynamic Meshes
Enabling Selective Surface-Based Collision
Playing Sounds on Collisions
Intersections
Mesh Class
Working with Console
Sharing Data
UnigineScript
Creating UnigineScript Application
Adding Scripts to the Project
Script Debugging
Cache Files
C++
Creating C++ Application
Creating C++ Plugin
C#
Creating C# Application
C# API Reference
UUSL (Unified UNIGINE Shader Language)
UUSL Keywords
UUSL Common Intrinsic Functions
UUSL GBuffer Structure
UUSL Data Structure
UUSL Parameters
UUSL Textures
UUSL Semantics
UUSL Tessellation
UUSL Compute Shaders
Creating a Custom Shader for Deferred Rendering Pass
Creating a Custom Shader for Forward Rendering Pass
Creating a Custom Shader for Post-Processing
File Formats
Mesh File Formats
Property File Format
Spline File Format
Startup Command-Line Options
Console
Configuration File
Rebuilding the Engine and Tools
Rebuild in Windows via Visual Studio
Semi-automatic Compilation with Build Script
Manual Compilation with SCons
Preprocessor Macros for Rebuilding the Engine
Protecting Your Data with a Password
GUI
RC Files
Skin Layout
Usage Example
Double Precision Coordinates
Usage
Performance Analyzer
How to Generate Shader Cache
API
Containers
Container Functions
ArrayVector Class
Map Class
Set Class
Common Functionality
Async Class
Atomiclock Class
Blob Class
CallbackBase Class
Checksum Class
Compress Class
ConsoleVariableFloat Class
ConsoleVariableInt Class
ConsoleVariableString Class
Expression Class
ExternClass Class
FunctionBase Class
Hash Class
Hasher Class
Image Class
Interpreter Class
Json Class
Log Class
OS Functions
Path Class
Plugin Class
Property Class
Ptr Class
Reflection Class
RegExp Class
Resource Class
Stream Class
String Class
StringArray Class
StringPtr Class
StringStack Class
System Functions
Thread Class
Timer Class
TypeInfo Class
Unigine Namespace Items
Utils Class
Xml Class
Variable Class
Controls-Related Classes
Controls Class
ControlsApp Class
ControlsDummy Class
ControlsJoystick Class
ControlsSixAxis
ControlsXPad360 Class
Engine-Related Classes
App Class
Config Class
Console Class
Editor Class
Engine Class
EnginePtr Class
engine.system Functions
EnginePlugins Class
Game Class
GameIntersection Class
Memory Class
Profiler Class
Properties Class
Sound Class
Sounds Class
Splash Class
Visualizer Class
World Class
Filesystem Functionality
Dir Class
File Class
FileSystem Class
FileSystemAssets Class
AsyncQueue Class
File System Functions
Package Class
PackageUng Class
UGUID Class
GUI-Related Classes
Gui Class
UserInterface Class
Widget Class
WidgetButton Class
WidgetCanvas Class
WidgetCheckBox Class
WidgetComboBox Class
WidgetDialog Class
WidgetDialogColor Class
WidgetDialogFile Class
WidgetDialogImage Class
WidgetDialogMessage Class
WidgetEditLine Class
WidgetEditText Class
WidgetExternBase Class
WidgetExtern Class
WidgetGridBox Class
WidgetGroupBox Class
WidgetHBox Class
WidgetHPaned Class
WidgetIcon Class
WidgetLabel Class
WidgetListBox Class
WidgetManipulator Class
WidgetManipulatorRotator Class
WidgetManipulatorScaler Class
WidgetManipulatorTranslator Class
WidgetMenuBar Class
WidgetMenuBox Class
WidgetScroll Class
WidgetScrollBox Class
WidgetSlider Class
WidgetSpacer Class
WidgetSpinBox Class
WidgetSprite Class
WidgetSpriteNode Class
WidgetSpriteShader Class
WidgetSpriteVideo Class
WidgetSpriteViewport Class
WidgetTabBox Class
WidgetTreeBox Class
WidgetVBox Class
WidgetVPaned Class
WidgetWindow Class
Math Functionality
Predefined Constants
Geometry Class
Math Common Functions
Math 2D Functions
Math Exponential Functions
Math Matrix Functions
Math Random Functions
Math Trigonometrical Functions
bvec4 Class
dmat4 Class
dvec2 Class
dvec3 Class
dvec4 Class
half Class
hvec2 Class
hvec3 Class
hvec4 Class
ivec2 Class
ivec3 Class
ivec4 Class
mat2 Class
mat3 Class
mat4 Class
quat Class
vec2 Class
vec3 Class
vec4 Class
Node-Related Classes
Node Class
NodeDummy Class
NodeExtern Class
NodeExternBase Class
NodeLayer Class
NodePivot Class
NodeReference Class
NodeTrigger Class
Networking Functionality
Socket Class
Pathfinding-Related Classes
Navigation Class
NavigationMesh Class
NavigationSector Class
Obstacle Class
ObstacleBox Class
ObstacleCapsule Class
ObstacleSphere Class
PathRoute Class
PathRouteIntersection Class
Physics-Related Classes
Physics Class
PhysicsIntersection Class
PhysicsIntersectionNormal Class
Plugins-Related Classes
AppEasyBlendInterface Class
ColladaImport Class
OpenFlightImport Class
engine.grabber Functions
engine.kinect Functions
engine.oculus Functions
AppProjectionInterface Class
engine.surround Functions
engine.vive Functions
engine.wall Functions
CIGI Client Plugin
CIGI Client interface
IArticulatedPart Class
IComponent Class
IEntity Class
IViewBase Class
IView Class
IViewGroup Class
ICigiHostPacket Class
ICigiArticulatedControl Class
ICigiArticulatedShortControl Class
ICigiAtmosphereControl Class
ICigiCelestialControl Class
ICigiComponentControl Class
ICigiComponentShortControl Class
ICigiEntityControl Class
ICigiEntityClampedControl Class
ICigiEnvironmentControl Class
ICigiEnvironmentRequest Class
ICigiIGControl Class
ICigiMaritimeControl Class
ICigiRateControl Class
ICigiSensorControl Class
ICigiSymbolCircleDef Class
ICigiSymbolClone Class
ICigiSymbolControl Class
ICigiSymbolShortControl Class
ICigiSymbolLineDef Class
ICigiSymbolSurfaceDef Class
ICigiSymbolTextDef Class
ICigiTerrestrialControl Class
ICigiTrackerControl Class
ICigiViewControl Class
ICigiWaveControl Class
ICigiWeatherControl Class
ICigiViewDef Class
ICigiEarthModelDef Class
ICigiSegmentDef Class
ICigiTrajectoryDef Class
ICigiVolumeDef Class
ICigiHatHotRequest Class
ICigiIGPacket Class
ICigiStartOfFrame Class
ICigiAerosolResponse Class
ICigiHatHotResponse Class
ICigiHatHotExtResponse Class
ICigiLosResponse Class
ICigiLosExtResponse Class
ICigiLosSegmentRequest Class
ICigiLosVectorRequest Class
ICigiMaritimeResponse Class
ICigiPositionRequest Class
ICigiPositionResponse Class
ICigiSensorResponse Class
ICigiSensorExtResponse Class
ICigiTerrestrialResponse Class
ICigiWeatherResponse Class
Rendering-Related Classes
Camera Class
Ffp Class
Material Class
Materials Class
Mesh Class
Primitives Class
Render Class
RenderEnvironmentPreset Class
Renderer Class
RenderContext Class
RenderState Class
Shader Class
StructuredBuffer Class
Texture Class
TextureRender Class
Viewport Class
Content Creation
3D Models Requirements
Art Assets Conversion
Content Optimization
Materials
Hierarchy and Inheritance
Custom Materials
Samples
Tutorials
Adding Morph Targets
Setting Up Object LODs
Adding Impostors to Clutters
Video Tutorials
Interface
Interface Overview
The Scene Viewport
Essentials
Importing 3D Models
Instancing Nodes
Materials
Lighting
Tracker Tool
Global Illumination
Migrating to UNIGINE 2.7
API Migration
Console Migration
Content Migration
Old Editor Workflow Projects
Assets Workflow Projects
Table of Contents
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.

System Requirements

In This Article:

Operating Systems

Notice
A 64-bit Operating System is required to develop applications using UNIGINE 2 SDK.
  • Windows (7 SP1/8/10) x86 / x64
  • Linux (kernel 3.0+) x86 / x64

CPU

UNIGINE can work on x86 processors with SSE2 support, i.e. starting with Intel Pentium 4 or AMD Athlon 64 and higher. The engine fully and efficiently utilizes the multi-core CPU architecture.

For optimal experience it is recommended to use Intel i5/i7 series processors with 3 GHz+ frequency.

RAM

Minimal RAM size is 1 GB. Actual RAM requirements of a UNIGINE-based application depend on the application itself.

Recommended RAM size is 8+ GB.

Storage

Minimal disk space for runtime components is 100 MB. Actual disk space requirements depends primarily on application content.

To use UNIGINE SDK during development time, it is recommended to have at least 10 GB free space.

GPU

  • Windows: all graphic cards with support for DirectX 11 or OpenGL 4.4+
  • Linux: all graphic cards with support for OpenGL 4.4+
Notice
Even if UNIGINE cannot recognize a graphics card, it still can detect the card's capabilities and use available features.
Notice
For optimal experience it is strongly recommended to use up-to-date proprietary video drivers.

NVIDIA

Supported NVIDIA GPUs:

  • GeForce 400 series: GTX 480, GTX 470, GTX 465, GTX 460 SE v2, GTX 460 SE, GTX 460, GTS 450, GT 440, GT 430, GT 420, 405
  • GeForce 500 series: GTX 590, GTX 580, GTX 570, GTX 560 Ti, GTX 560 SE, GTX 560, GTX 555, GTX 550 Ti, GT 545, GT 530, GT 520, 510
  • GeForce 600 series: GTX 690, GTX 680, GTX 670, GTX 660 Ti, GTX 660, GTX 650 Ti BOOST, GTX 650 Ti, GTX 650, GTX 645, GT 645, GT 640, GT 630, GT 620, GT 610, 605
  • GeForce 700 series: GTX TITAN Z, GTX TITAN Black, GTX TITAN, GTX 780 Ti, GTX 780, GTX 770, GTX 760, GTX 760 Ti (OEM), GTX 750 Ti, GTX 750, GTX 745, GT 740, GT 730
  • GeForce 900 series: GTX 960, GTX 970, GTX 980, GTX 980 Ti, GTX Titan X
  • GeForce 1000 series: GTX 1080, GTX 1070, GTX 1060
  • Quadro series: M6000, M5000, M4000, K6000, K5200, K5000

NVIDIA SLI technology is supported.

AMD

Supported AMD GPUs:

  • Evergreen (HD 5xxx) series: 5450, 5550, 5570, 5610, 5670, 5750, 5770, 5830, 5850, 5870, 5970
  • Mobility Radeon HD 5xxx series: HD 5430, HD 5450, HD 5470, HD 5650, HD 5730, HD 5750, HD 5770, HD 5830, HD 5850, HD 5870
  • Radeon HD 6xxx series: 6250, 6290, 6310, 6320, 6350, 6450, 6570, 6670, 6750, 6770, 6790, 6850, 6870, 6930, 6950, 6970, 6990
  • Radeon HD 6xxxM series: 6350M, 6350M, 6370M, 6490M, 6530M, 6550M, 6570M, 6630M, 6650M, 6730M, 6750M, 6770M, 6830M, 6850M, 6870M, 6950M, 6970M, 6990M
  • Radeon HD 6xxxG series: 6380G, 6480G, 6520G, 6620G
  • Radeon HD 7xxx series: 7350, 7450, 7470, 7480D, 7510, 7540D, 7560D, 7570, 7660D, 7670, 7730, 7750, 7770 GHz Edition, 7790, 7850, 7870 GHz Edition, 7870 XT, 7950, 7950 Boost, 7970, 7970 GHz Edition, 7990
  • Radeon HD 7xxxM series: 7430M, 7450M, 7470M, 7490M, 7510M, 7530M, 7550M, 7570M, 7590M, 7610M, 7630M, 7650M, 7670M, 7690M, 7690M XT, 7730M, 7750M, 7770M, 7850M, 7870M, 7970M
  • Radeon HD 7xxxG series: 7400G, 7420G, 7500G, 7520G, 7600G, 7620G, 7640G, 7660G
  • Radeon HD 8xxx series: 8350, 8450, 8470, 8490, 8570, 8670, 8730, 8760, 8770, 8870, 8950, 8970, 8990
  • Radeon R5/7/9 200 series: R5 210, R5 220, R5 230, R5 235, R5 235X, R5 240, R7 240, R7 250, R7 250X, R7 260, R7 260X, R7 250E, R7 265 R9 270, R9 270X, R9 280, R9 280X, R9 285, R9 290, R9 290X, R9 295X2
  • Radeon R5/7/9 M200 series: R5 M230, R5 M255, R7 M260, R7 M260X, R7 M265, R9 M265X, R9 M270X, R9 M275X, R9 M280X, R9 M290X, R9 M295X
  • Radeon R5/7/9 300 series: R5 330, R5 340, R7 340, R7 350, R7 360, R9 370, R9 370X, R9 380, R9 380X, R9 390, R9 390X, R9 Fury, R9 Fury X, R9 Nano, Pro Duo
  • Radeon R5/7/9 M300 series: R5 M330, R5 340, R5 M335, R7 M360, R9 M365X, R9 M370X, R9 M375, R9 M375X, R9 M380, R9 M385, R9 M385X, R9 M390, R9 M390X, R9 M395, R9 M395X
  • Radeon RX 400 series: RX 460, RX 470, RX 480
  • Radeon RX M400 series: R5 M420, R5 M430, R7 M435, R5 M440, R7 M445, R7 M460, R7 M465, R7 M465X, R9 M470, R9 M470X, R9 M485X

AMD CrossFire technology is supported.

Intel

Supported Intel GPUs:

  • Seventh generation: HD Graphics 4000, HD Graphics P4000, HD Graphics 4200, HD Graphics 4400, HD Graphics 4600, HD Graphics P4600, HD Graphics P4700, HD Graphics 5000, Iris Graphics 5100, Iris Pro Graphics 5200
  • Eighth generation: HD Graphics 5300, HD Graphics 5500, HD Graphics 5600, HD Graphics P5700, HD Graphics 6000, Iris Graphics 6100, Iris Pro Graphics 6200, Iris Pro Graphics P6300
  • Ninth generation: HD Graphics 500, HD Graphics 505, HD Graphics 510, HD Graphics 515, HD Graphics 520, HD Graphics 530, HD Graphics P530, Iris 540, Iris 550, Iris Pro 580, Iris Pro P580

Video RAM

Minimal VRAM size is 2 GB. Actual VRAM requirements of a UNIGINE-based application depend on the application itself.

Recommended VRAM size is 4+ GB.

Output Devices

  • Standard monitor
  • Oculus Rift DK2 / CV1
  • HTC Vive
  • Stereo system (NVIDIA 3D Vision, anaglyph, side-by-side, interlaced, separate images)
  • Multi-monitor systems (monitor walls, CAVEs, NVIDIA Surround, AMD Eyefinity, etc.)
  • Multi-channel (network cluster)

Input Devices

  • PC keyboard
  • PC mouse
  • PC joystick
  • PC wheel controller
  • Xbox 360 controller
  • Multi-touch screen

Sound Cards

All sound devices supported by OpenAL library (virtually any standard sound device).

Last update: 2018-04-26
Build: ()