QVR 4.0.1
A library to build Virtual Reality applications
Public Member Functions | Friends | List of all members
QVRProcessConfig Class Reference

Configuration of a QVRProcess. More...

#include <config.hpp>

Public Member Functions

 QVRProcessConfig ()
 Constructor. More...
 
const QString & id () const
 Returns the unique id of this process. More...
 
QVRIpcType ipc () const
 Returns the type of inter-process communication to use. More...
 
const QString & address () const
 Returns the IP address that the QVR server will listen on. More...
 
const QString & launcher () const
 Returns the launcher command used to launch this process. More...
 
const QString & display () const
 Returns the display that this process works with. More...
 
bool syncToVBlank () const
 Returns whether windows of this process are synchronized with the vertical refresh of the display. More...
 
bool decoupledRendering () const
 Returns whether the rendering of this child process is decoupled from the main process. More...
 
const QList< QVRWindowConfig > & windowConfigs () const
 Returns the configurations of the windows on this process. More...
 

Friends

class QVRConfig
 

Detailed Description

Configuration of a QVRProcess.

Each process works with only one display. The main process talks to the display that Qt initially uses by default; if a different display is configured, QVR will relaunch the main process automatically so that Qt talks to the configured display insted. Child processes are usually configured to use different displays.

The idea is that one display (with potentially multiple screens) runs on one GPU.

Constructor & Destructor Documentation

◆ QVRProcessConfig()

QVRProcessConfig::QVRProcessConfig ( )

Constructor.

Member Function Documentation

◆ address()

const QString & QVRProcessConfig::address ( ) const
inline

Returns the IP address that the QVR server will listen on.

A QVR server is only started on the main process (which is the application process that is started first), and only if multiple processes are configured. A TCP QVR server that listens on a network address is only used if configured manually or if at least one of the processes is run on a remote host (which is assumed to be the case when a launcher is configured; see launcher()).

By default, a TCP QVR server listens on all IP addresses of the host.

◆ decoupledRendering()

bool QVRProcessConfig::decoupledRendering ( ) const
inline

Returns whether the rendering of this child process is decoupled from the main process.

◆ display()

const QString & QVRProcessConfig::display ( ) const
inline

Returns the display that this process works with.

◆ id()

const QString & QVRProcessConfig::id ( ) const
inline

Returns the unique id of this process.

◆ ipc()

QVRIpcType QVRProcessConfig::ipc ( ) const
inline

Returns the type of inter-process communication to use.

◆ launcher()

const QString & QVRProcessConfig::launcher ( ) const
inline

Returns the launcher command used to launch this process.

This is only required when processes need to run on remote computers, but can also be useful for starting processes under e.g. valgrind, or with specific operating system settings, e.g. using taskset.

Example for ssh (passwordless login to remotehost must be set up): launcher ssh remotehost

Example for ssh if you use libraries in non-standard locations: launcher ssh remotehost env LD_LIBRARY_PATH=/path/to/libs

When the special string manual is used as launcher command, QVR will not start the process itself, and instead expects the user to start it manually. A list of options that the process needs to be started with will be printed to the terminal.

◆ syncToVBlank()

bool QVRProcessConfig::syncToVBlank ( ) const
inline

Returns whether windows of this process are synchronized with the vertical refresh of the display.

◆ windowConfigs()

const QList< QVRWindowConfig > & QVRProcessConfig::windowConfigs ( ) const
inline

Returns the configurations of the windows on this process.

Friends And Related Function Documentation

◆ QVRConfig

friend class QVRConfig
friend

The documentation for this class was generated from the following file: