Programming
Fundamentals
Setting Up Development Environment
Usage Examples
UnigineScript
C#
UUSL (Unified UNIGINE Shader Language)
File Formats
Rebuilding the Engine and 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
Networking Functionality
Pathfinding-Related Classes
Physics-Related Classes
Plugins-Related Classes
CIGI Client Plugin
Rendering-Related Classes

Syncker-Specific Options

There are 2 types of Syncker-specific options:

  • Command-line options, which are used to specify screen configuration, broadcast address of the master computer, TCP and UDP ports on the application start-up. These options have the same syntax as the other start-up command-line options.
  • Console options that can be run from the application console on the master or slave sides.

Command-Line Options

Common Options

The following command-line options can be run on master or slave application start-up:

Name Description Arguments Default
sync_mesh Specifies a configuration mesh to be used. This mesh represents a configuration of monitors, onto which the application is rendered (1 unit = 1 meter). Each surface of the mesh corresponds to one of the monitors. Projection and modelview matrices are automatically calculated on the basis of the camera position and slave name. When no configuration mesh is specified, all slaves clone master's display.
Notice
Check the full list of mesh requirements here.
Shell commands
main_x86 -sync_mesh "my_project/meshes/my_mesh.mesh"
A path to the .mesh file. No mesh is set by default.
sync_master Sets the flag indicating whether the computer is a master.
Shell commands
main_x86 -sync_master 1
Master flag. 0
sync_tcp_port Sets the TCP port to be used to send and receive critical messages with guaranteed delivery.
Shell commands
main_x86 -sync_tcp_port 8891
TCP port number. 8891
sync_tcp_ping_port Sets the TCP port to be used for ping messages.
Shell commands
main_x86 -sync_tcp_ping_port 8892
TCP port number. 8892
sync_udp_port Sets the UDP port to be used to send and receive non-critical messages.
Shell commands
main_x86 -sync_udp_port 8890
UDP port number. 8890
sync_view Sets the view (surface of the configuration mesh) to be used. This option is equivalent to sync_view_0.
Shell commands
main_x86 -sync_view surface_name
Name of the surface of the configuration mesh. -
sync_view_0 Sets the view (surface of the configuration mesh) to be used for the 1st monitor of the computer.
Shell commands
main_x86 -sync_view_0 surface_name
Name of the surface of the configuration mesh. -
sync_view_1 Sets the view (surface of the configuration mesh) to be used for the 2nd monitor of the computer.
Notice
To be specified when a multi-monitor configuration is used.
Shell commands
main_x86 -sync_view_1 surface_name
Name of the surface of the configuration mesh. -
sync_view_2 Sets the view (surface of the configuration mesh) to be used for the 3rd monitor of the computer.
Notice
To be specified when a multi-monitor configuration is used.
Shell commands
main_x86 -sync_view_2 surface_name
Name of the surface of the configuration mesh. -
sync_view_3 Sets the view (surface of the configuration mesh) to be used for the 4th monitor of the computer.
Notice
To be specified when a multi-monitor configuration is used.
Shell commands
main_x86 -sync_view_3 surface_name
Name of the surface of the configuration mesh. -
sync_view_4 Sets the view (surface of the configuration mesh) to be used for the 5th monitor of the computer.
Notice
To be specified when a multi-monitor configuration is used.
Shell commands
main_x86 -sync_view_4 surface_name
Name of the surface of the configuration mesh. -
sync_view_5 Sets the view (surface of the configuration mesh) to be used for the 6th monitor of the computer.
Notice
To be specified when a multi-monitor configuration is used.
Shell commands
main_x86 -sync_view_5 surface_name
Name of the surface of the configuration mesh. -

Master Options

The following command-line options can be run on the master application start-up:

Name Description Arguments Default
sync_broadcast_address Sets a broadcast address of the master computer that is used to broadcast messages to slaves over the network.
Shell commands
main_x86 -sync_broadcast_address "xxx.xxx.xxx.xxx"
A broadcast address in the xxx.xxx.xxx.xxx format. 127.255.255.255

Slave Options

The following command-line options can be run on the slave application start-up:

Name Description Arguments Default
sync_slave_name Sets a name of the slave computer used to display connect/disconnect messages.
Shell commands
main_x86 -sync_slave_name "slave1"
A slave name, string. slave

Console Commands

The following console commands can be run on a master or a slave computer.

Name Description Arguments
syncker_max_fps
  • Command. Sets the maximum FPS value for the computer.
    Notice
    To disable framerate clamping use -1.

FPS value.

By default, 60 FPS is used.

syncker_console
  • Command. Runs the specified console command on master and all slaves.
    Source code
    syncker_console show_profiler 3 
    //shows the profiler on all computers 
    
    syncker_console syncker_max_fps 60 
    //sets maximum framerate to 60 on all computers

A console command to run.

syncker_interpolation

0 - disabled

1 - enabled (by default)

syncker_interpolation_period
  • Variable. Prints the current interpolation period value for the computer, in seconds.
  • Command. Sets the interpolation period for the computer.
    Source code
    syncker_interpolation_period 0.04

Interpolation period, in seconds

(0.04 - by default)

syncker_extrapolation_period
  • Variable. Prints the current extrapolation period value for the computer, in seconds.
  • Command. Sets the extrapolation period for the computer.
    Source code
    syncker_extrapolation_period 0.2

Extrapolation period, in seconds

(0.2 - by default)

Last update: 2017-10-20