This page has been translated automatically.
Click here to view the original English version instead.
Getting Started
What's Inside?
Downloading and Installing UNIGINE SDK
Project Workflow
Programming Quick Start
Programming Quick References
1. Setting Up the Project
2. Creating the Controllable Character
3. Implementing Shooting
4. Generating Physical Objects
5. Implementing Color Zone
6. Playing Background Music
7. Managing Game Rules
8. Creating the End UI
9. Building the Project
Getting Started with VR
Classes and Components Overview
System Requirements
Migrating to UNIGINE
Migrating to UNIGINE From Unreal Engine
Content Creation
Programming
Physics
Migrating to UNIGINE From Unity
Content Creation
Programming
Physics
Video Tutorials
Interface
SDK Browser Interface
Editor Interface
Scene Viewport
Essentials
Importing 3D Models
Instancing Nodes
Materials
Lighting
Tracker Tool
Global Illumination
Georeferenced Terrain Generation
Arbitrary Terrain Generation
Content Optimization
Decals
Performance Inspection with Microprofile
Textures
Procedural Texturing
Bit Masking
Audio Sources and Sound Effects
Cached Shadows
Water
Physics
C# Component System
Landscape Terrain
Volumetric Clouds
Advanced
Microprofile for Artists
How To
Principles of Operation
Virtual World Structure
World Management
Properties
Hierarchy and Inheritance
Component System
C++ Component System
C# Component System
Rendering
Rendering Sequence
Parallel-Split Shadow Mapping
Interleaved Lights Rendering
Alpha Blending
Physics
Shapes
Collision Detection
Joints
Simulation of Physics
Bit Masking
Import System
Export System
File System
Asynchronous Data Streaming
SDK Browser
Projects
Licenses
Managing Company Accounts and Licenses
Add-Ons
Airport Assets
Eastern European Countryside
Docs Sample Content
Industrial Assets
Road Tool Constructor
Scans
Vegetation
VFX
Weather
Arbitrary Terrain Generation
Georeferenced Terrain Generation
Demos
CIGI
C# Third Person Platformer
CPP Samples
Earthworks
Fox Hole
High-Level Vehicle
Mars
Oil Platform
Oil Refinery
Orbits
Superposition
Syncker
Viewer
VR Sample
API Samples
UnigineEditor
Interface Overview
Layout Customization
Context Menus
Assets Workflow
Asset Types
Assets and Runtime Files
Organizing Assets
Copying Assets From Other Projects
Project Files
Version Control
Settings and Preferences
Editor Settings and Hotkeys
World Settings
Global Physics Settings
Global Sound Settings
Controls Settings
Working With Projects
Packing a Final Build for Publishing
Managing Worlds
Scene Navigation
Creating Nodes
Selecting and Positioning Nodes
Organizing Nodes
Exporting Nodes
Instancing Nodes
Adjusting Node Parameters
Transformation and Common Parameters
Visual Representation
Properties
Physics and Sound
Setting Up Materials
Organizing Materials
Forced Shader Compilation
Setting Up Properties
Organizing Properties
Lighting
Environment
Light Meter
Reflections
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
Sandworm
Starting with Sandworm
Questions and Answers
Using Editor Tools for Specific Tasks
Capturing Screenshots and Frame Sequences
Adding Variations for a More Realistic Environment
Generating Impostors with Impostors Creator
Editing Global Terrain
Editing Landscape Terrain
Mask Editor for Grass and Clutters
Cluster Editor
Extending Editor Functionality
Setting Up Environment
Creating Your First Editor Plugin
Editing Curves
Tools
Plugins for 3D Editors
Plugins for 3ds Max
Plugins for Maya
Performance Profiling Tools
Performance Profiler
Microprofile
USC Interpreter
Archiver
Resource
Upgrade Script
Runtimes Generator
Built-in Node Types
Nodes
Node
Node Reference
Dummy Node
Layer
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
Planar Reflection Probe
Geodetics
Geodetic Pivot
World Nodes
World Trigger
World Clutter
Switcher
World Expression
World Spline Graph
Sound Objects
Sound Source
Sound Reverb
Pathfinding Objects
Players
Player Actor
Player Dummy
Player Persecutor
Player Spectator
Programming
Fundamentals
Programming Overview
Engine Architecture
Working with Smart Pointers
Accessing Nodes and Files via Properties
Thread Safety
Matrix Transformations
Camera Matrices
Event Handling Callbacks
Setting Up Development Environment
Windows Development Environment
Linux Development Environment
Usage Examples
Working with Landscape Terrain via Code
High-Level Car Physics System (C++)
Custom Import Plugin
Importing Models Directly to Memory
C++ Component System
Customizing Mouse Cursor and Behavior
Basic Object Movements
Creating and Attaching a Cloth
Creating a Car with Wheel 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
Splitting Logic Between Several WorldLogic Classes
Using Manipulators to Transform Objects
Making Screenshots at Runtime
Handling Contacts on Collision
C++
Creating C++ Application
Creating C++ Plugin
C#
Creating C# Application
Debugging C# Components
Garbage Collector
C# API Reference
UnigineScript
Creating UnigineScript Application
Adding Scripts to the Project
Script Debugging
Handling Ownership When Using Scripts
Cache Files
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
Plugins
ARTTRACK Plugin
FbxImporter Plugin
CadImporter Plugin
Setting Up Projections with AppEasyBlend Plugin
GeodeticsPlugin
GPU Monitoring with GPUMonitor Plugin
Kinect2 Plugin
LeapMotion Plugin
Secure SSL Connection via SSLSocket Plugin
Teslasuit Plugin
VRPN Plugin
FMOD Plugin
File Formats
Unigine Language Object Notation
Mesh File Formats
Property File Format
Spline File Format
Startup Command-Line Options
Console
Configuration Files
Rebuilding the Engine Tools
Rebuild in Windows via Visual Studio
Semi-automatic Compilation with Build Script
Protecting Your Data with a Password
GUI
Loading and Splash Screens
RC Files
Skin Layout
Usage Example
Double Precision Coordinates
Usage
Performance Analyzer
API
Containers
Container Functions
ArrayVector Class
BiMap Class
HashMap Class
HashSet Class
Map Class
Pair Class
Set Class
Common Functionality
Async Class
ScopedLock Class
ScopedReaderLock Class
ScopedReentrantLock Class
ScopedWriterLock Class
Atomic Class
BackoffSpinner Class
Mutex Class
ReentrantMutex Class
RWMutex Class
Blob Class
Signal Class
Compress Class
ConsoleVariableFloat Class
ConsoleVariableInt Class
ConsoleVariableString Class
Curve2d Class
Expression Class
ExternClass Class
FunctionBase Class
Hash Class
Hasher Class
Image Class
ImageConverter Class
Interpreter Class
Json Class
Log Class
OS Functions
Palette Class
Path Class
Plugin Class
Property Class
PropertyParameter Class
Ptr Class
Reflection Class
RegExp Class
Resource Class
Stream Class
String Class
StringArray Class
StringPtr Class
StringStack Class
Thread Class
Time Class
Timer Struct
TypeInfo Class
UlonArg Class
UlonValue Class
UlonNode Class
Unigine Namespace Items
Utils Class
Xml Class
Variable Class
Controls-Related Classes
Controls Class
ControlsApp Class
ControlsDummy Class
ControlsJoystick Class
ControlsSixAxis
ControlsXPad360 Class
Input Class
InputGamePad Class
Engine-Related Classes
App Class
BootConfig Class
CustomApp Class
Config Class
Console Class
Editor Class
Engine Class
EnginePtr Class
engine.system Functions
EnginePlugins Class
Game Class
GameIntersection Class
LoadingScreen Class
Memory Class
Profiler Class
Properties Class
Sound Class
Sounds Class
SystemDialog Class
SystemInfo Class
UserConfig Class
Visualizer Class
World Class
Filesystem Functionality
Dir Class
File Class
FileSystem Class
FileSystemAssets Class
FileSystemMount 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
WidgetSpinBoxDouble Class
WidgetSprite Class
WidgetSpriteNode Class
WidgetSpriteShader Class
WidgetSpriteVideo Class
WidgetSpriteViewport Class
WidgetTabBox Class
WidgetTreeBox Class
WidgetVBox Class
WidgetVPaned Class
WidgetWindow Class
Math Functionality
Node-Related Classes
Node Class
NodeDummy Class
NodeExtern Class
NodeExternBase Class
NodeLayer Class
NodeReference Class
NodeTrigger Class
Objects-Related Classes
Object Class
ObjectBillboards Class
ObjectCloudLayer Class
ObjectDummy Class
ObjectDynamic Class
ObjectExtern Class
ObjectExternBase Class
ObjectGrass Class
ObjectGui Class
ObjectGuiMesh Class
ObjectIntersection Class
ObjectIntersectionNormal Class
ObjectIntersectionTexCoord Class
ObjectMeshStatic Class
ObjectMeshCluster Class
ObjectMeshClutter Class
ObjectMeshDynamic Class
ObjectMeshSkinned Class
ObjectMeshSplineCluster Class
ObjectSky Class
ObjectTerrainGlobal Class
TerrainGlobalDetail Class
TerrainGlobalLod Class
TerrainGlobalLodHeight Class
TerrainGlobalLods Class
TileSet Class
TileSetFile Class
ObjectText Class
ObjectVolumeBox Class
ObjectVolumeOmni Class
ObjectVolumeProj Class
ObjectVolumeSphere Class
ObjectWaterMesh Class
ObjectWaterGlobal 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
Contact Class
ShapeContact Class
Physics Class
PhysicsIntersection Class
PhysicsIntersectionNormal Class
Plugins-Related Classes
AppEasyBlend Class
OpenFlightImport Class
Kinect Class
AppOculus Class
AppProjection Class
engine.surround Functions
AppVarjo Class
AppVive Class
AppWall Class
ARTTracker Class
IG Plugin
CIGIConnector Plugin
CIGI::Connector Class
CigiAerosolResponse Class
CigiAnimationNotify Class
CigiArticulatedControl Class
CigiArticulatedShortControl Class
CigiAtmosphereControl Class
CigiCelestialControl Class
CigiComponentControl Class
CigiComponentShortControl Class
CigiEarthModelDef Class
CigiEntityClampedControl Class
CigiEntityControl Class
CigiEnvironmentControl Class
CigiEnvironmentPolygonControl Class
CigiEnvironmentRequest Class
CigiEventNotify Class
CigiHatHotExtResponse Class
CigiHatHotRequest Class
CigiHatHotResponse Class
CigiHostPacket Class
CigiHostUserDefined Class
CigiIGControl Class
CigiIGMessage Class
CigiIGPacket Class
CigiIGUserDefined Class
CigiLosExtResponse Class
CigiLosResponse Class
CigiLosSegmentRequest Class
CigiLosVectorRequest Class
CigiMaritimeControl Class
CigiMaritimeResponse Class
CigiPositionRequest Class
CigiPositionResponse Class
CigiRateControl Class
CigiSegmentDef Class
CigiSegmentNotify Class
CigiSensorControl Class
CigiSensorExtResponse Class
CigiSensorResponse Class
CigiStartOfFrame Class
CigiSymbolCircleDef Class
CigiSymbolClone Class
CigiSymbolControl Class
CigiSymbolLineDef Class
CigiSymbolShortControl Class
CigiSymbolSurfaceDef Class
CigiSymbolTextDef Class
CigiTerrestrialControl Class
CigiTerrestrialResponse Class
CigiTrackerControl Class
CigiTrajectoryDef Class
CigiViewControl Class
CigiViewDef Class
CigiVolumeDef Class
CigiVolumeNotify Class
CigiWaveControl Class
CigiWeatherControl Class
CigiWeatherResponse Class
IG Manager Class
IGConfig Class
Component Class
ComponentBaseInterface
IGIntersection Structure
ArticulatedPart Class
CollisionSegment Class
CollisionVolume Class
Converter Class
Entity Class
LightController Class
Meteo Class
MeteoCameraEffects Class
MeteoPositionParam Structure
Region Class
SkyMap Class
SymbolsController Class
SymbolsPlane Class
Symbol Class
SymbolPolyline Class
SymbolCircle Class
SymbolText Class
ViewBase Class
ViewGroup Class
View Class
Water Class
WeatherLayer Class
WeatherLayerCloud Class
WeatherLayerPrecipitation Class
Rendering-Related Classes
Camera Class
EngineExpression Class
Ffp Class
Material Class
Materials Class
Mesh Class
MeshDynamic Class
MeshStatic Class
Primitives Class
Render Class
RenderEnvironmentPreset Class
Renderer Class
RenderContext Class
RenderState Class
RenderTarget Class
Shader Class
CPUShader Class
StructuredBuffer Class
Texture Class
TextureCurve Class
Viewport Class
Content Creation
3D Models Requirements
Art Assets Conversion
Content Optimization
Textures Optimization
Lights Optimization
Dynamic Reflections Optimization
Water Optimization
Terrain Optimization
Physics Optimization
VR Best Practices
Materials
Hierarchy and Inheritance
Material Nodes Library
Miscellaneous
Material Node
Final Node
To Int Node
Portal In Node
Portal Out Node
Expression Node
Function Node
Sub Graph Node
Loop Begin Node
Loop End Node
Rotate Space Node
Transform Space Node
Reflect Node
Refract Node
Time Node
Rotate UV Node
Compose Float2
Compose Float3
Compose Float4
Compose Int2
Compose int3
Compose Int4
Compose Float By Exponent
Decompose Float By Exponent
Color Saturation Node
Contrast Node
Levels Node
Posterize Node
RGB To Luma Node
RGB To HCV Node
RGB To HSL Node
HSL To RGB Node
Overlay Node
Srgb Node
Srgb Inverse Node
Screen UV To View Direction Node
Position to Screen UV Node
Reorient Normal Blend Node
Reorient Vector Blend Node
Normal Reconstruct Z Node
Position to Normal Node
Specular to Metalness Node
Calc Mip Level Node
Calculate TBN Node
Parallax Occlusion Mapping Node
Parallax Simple Node
Face Forward Node
Vertex Interpolation Node
Pack Unit Vector To Octahedron
Unpack Octahedron To Unit Vector
Pack 1212 To 888
Pack 888 To 1212
Pack 88 To 16
Pack 16 To 88
Pack 44 To 8
Pack 8 To 44
Pack 1616 To 8888
Pack 8888 To 1616
Refraction Simple For Thick Objects Node
Refraction Screen UV Offset For Thick Objects Node
Refraction Simple For Thin Objects Node
Refraction Screen UV Offset For Thin Objects Node
Refraction Raymarched Node
Reflection Simple Node
Reflection Raymarched Node
Triplanar Color Node
Triplanar Normal Node
Blend By Height Node
Tiling and Offset Node
Normal From Height Value Node
Normal From Height Texture Node
Depth Fade Node
Interior Mapping Texture 2D Node
Interior Mapping Cubemap Node
Blackbody Node
Fresnel Node
Tree Animation Node
Grass Animation Node
Input
Is Auxiliary Pass Node
Is GBuffer Pass Node
Is Shadow Pass Node
Is Baking GI Node
Is Lightmap Node
Is Front Face Node
View Direction Node
Camera Direction Node
Camera Offset Node
Camera Position Node
Camera Near Node
Camera Far Node
Camera INear Node
Camera IFar Node
Matrix Projection Node
Matrix IProjection Node
Matrix Camera Projection Node
Matrix Camera IProjection Node
Matrix Modelview Node
Matrix IModelview Node
Matrix Old Modelview Node
Matrix Old IModelview Delta Node
Matrix Old IModelview Node
Oblique Frustum Plane Node
Screen Resolution Node
Screen IResolution Node
Screen Coord Node
Screen UV Node
Vertex Tangent Node
Vertex Binormal Node
Vertex Normal Node
Vertex Color Node
Vertex Position Node
Vertex UV 0 Node
Vertex UV 1 Node
Vertex ID Node
Instance ID Node
Material Mask Node
Up Node
Down Node
Forward Node
Back Node
Right Node
Left Node
Vertex Front Face Node
Object Position Node
Sun Direction Node
Moon Direction Node
Float Node
Float2 Node
Float3 Node
Float4 Node
Color (Float3) Node
Color (Float4) Node
Int Node
Int2 Node
Int3 Node
Int4 Node
Bool Node
Frame Node
IFps Node
Game Scale Node
Math
Add Node
Subtract Node
Multiply Node
Frac Node
DDX Node
DDX Coarse Node
DDX Fine Node
DDY Node
DDY Coarse Node
DDY Fine Node
DDXY Node
Clamp Node
Saturate Node
Power Node
Ceiling Node
Floor Node
Absolute Node
Sign Node
Base-E Logarithm Node
Base-2 Logarithm Node
Base-10 Logarithm Node
Base-2 Exponential Node
Base-E Exponential Node
Increment Node
Decrement Node
Mod Node
FMod Node
Divide Node
Divide Int Node
Reciprocal Node
Maximum Node
Maximum Possible Float Node
Maximum Possible Half Node
Maximum Possible Int Node
Minimum Node
Minimum Possible Float Node
Minimum Possible Int Node
Rerange Node
Square Root Node
Reciprocal Square Root Node
Round Node
Multiply And Add Node
ModF Node
Step Node
Smooth Step Node
Length Node
Length Squared Node
Normalize Node
Cross Node
Dot Product Node
Lerp Node
Lerp3 Node
Lerp Contrast Preserving Node
Inverse Lerp Node
Golden Ratio Node
Pi Node
Reverse Bits Node
Is Finite Node
Is Infinity Node
Is Nan Node
All Node
Any Node
First Bit High Node
First Bit Low Node
Distance Node
Matrix
Compose Matrix3
Compose Matrix3 By Column
Compose Matrix3 By Row
Compose Matrix4
Compose Matrix4 By Column
Compose Matrix4 By Row
Get Matrix Column
Get Matrix Row
Get Matrix Value
Set Matrix Column
Set Matrix Row
Set Matrix Value
Is Ortho
Basis X
Basis Y
Basis Z
Determinant
Orthonormalize
Scale
Translate
Transpose
Inverse
Inverse Transform
Decompose Euler
Rotate Euler
Rotate Axis
Rotate X
Rotate Y
Rotate Z
Decompose Transform
Compose Transform
Matrix Multiply 3x3
Matrix Multiply 4x4
Ortho
Frustum
Perspective
Cube Transform
Matrix Object To Absolute World
Matrix Object To Camera World
Matrix Object To View
Matrix View To Object
Matrix View To Absolute World
Matrix View To Camera World
Matrix Absolute World To View
Matrix Absolute World To Object
Matrix Camera World To View
Matrix Camera World To Object
Textures
Light Map Texture Node
Texture 2D Node
Texture 2D Array Node
Texture 3D Node
Texture Cube Node
Sample Texture Node
Texture Resolution Node
Texture Buffer GBuffer Albedo Node
Texture Buffer GBuffer Normal Node
Texture Buffer GBuffer Shading Node
Texture Buffer GBuffer Velocity Node
Texture Buffer Curvature Node
Texture Buffer Auxiliary Node
Texture Buffer Lights Node
Texture Buffer Depth Node
Texture Buffer Depth Opacity Node
Texture Buffer Depth Opacity Fast Node
Texture Buffer Screen Color Node
Texture Buffer Screen Color Old Node
Texture Buffer Screen Color Old Reprojection Node
Texture Buffer Screen Color Opacity Node
Texture Buffer GBuffer Material Mask Node
Texture Buffer Normal Fast Node
Texture Buffer Refraction Node
Texture Buffer Refraction Mask Node
Texture Buffer SSAO Node
Texture Buffer SSGI Node
Texture Buffer SSR Node
Texture Buffer Transparent Blur Node
Texture Buffer Auto Exposure Node
Texture Buffer Auto White Balance Node
Texture Buffer Bent Normal Node
Texture Buffer DOF Mask Node
Custom Materials
Scriptable Materials
Art Samples
Animated Character
Billboards
Camera Effects
Clouds
Cluster
Clutter
Cross Section
Decals
Environment
Global Illumination
Impostors
Interior
Landscape
Lens Flares
Lights
LOD System
Materials
Occluders
Particles
Post Sensors
Reflections
Simlights
SSBevel
SSDirt
Vegetation
Volumetrics
Water
Wildfire
World Spline Graph
Tutorials
Adding Morph Targets
Vegetation: Authoring Tips
Upgrading to UNIGINE 2.15
API Migration
UUSL and Shaders Migration
Console Migration
Content Migration
IG Template
IG Configuration
Environment Settings
Light Settings
Entity-Related Properties
Creating Custom Components
Processing User-Defined Packets
Debugging IG Application
IG Editor Plugin
IG Host
Troubleshooting
SDK Browser Issues
UnigineEditor Issues
.NET Issues
Third-Party Notices
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.

C++ API

UNIGINE SDK browser contains a set of C++ samples demonstrating various aspects that can be implemented via code. You can run each sample and open and edit its code in IDE.

C++ API Samples section

Last update: 2022-01-21
Build: ()