Vrui's main configuration file, Vrui.cfg, is a hierarchical collection of sections containing tag/value pairs not unlike the Windows registry. The main difference is that Vrui configuration files are plain text, and that they contain strongly typed values from a rich set of types (see Vrui Configuration File Settings Value Type Reference). The outermost section in Vrui.cfg is always called "Vrui," and inside that section are any number of root sections defining the configurations of separate complete Vrui environments. These root sections are typically named by the host name of the computer running the respective environment, such that the Vrui run-time can automatically configure itself to the environment in which it is run at any given time.
The rest of this document lists and explains all tag/value pairs that exist within the following section types:
| Setting Tag | Setting Value Type | Setting Description |
|---|
| enableMultipipe | boolean |
Master toggle for cluster-based multipipe rendering. If true, Vrui will read the following multipipe... settings and configure itself to run in a distributed environment where applications are replicated across cluster nodes and synchronized by sharing input device data and application-specific data streams. This is not the appropriate rendering mode for single-system-image multipipe architectures (such as SGI Onyx/Prism). |
| multipipeMaster | string |
Internet host name or dotted-form IP address of the master node in a distributed rendering environment. The master node is the one where users log in and start Vrui applications. Some Vrui settings rely on node indices; the index of the master node is always zero. |
| multipipeMasterPort | integer |
Number of the UDP port used for cluster communication on the master node. This port needs to be accessible from the slave nodes, i.e., it must be accepted by any installed firewalls.
Note: The master port number can be identical to the multicast port number (see below), but ideally it should be different. |
| multipipeSlaves | list of strings |
List of the internet host names or dotted-form IP addresses of the slave nodes in a distributed rendering environment. A Vrui application started on the master node will replicate itself onto these slave nodes using the multipipeRemoteCommand. Some Vrui settings rely on node indices; slave nodes are numbered in the order in which they appear in the list, starting at one. |
| multipipeMulticastGroup | string |
Internet name or dotted-form IP address of the multicast or broadcast address used for communication from the master node to the slave nodes. Vrui uses a multicast protocol if the given address is a valid IETF multicast address, and uses a broadcast protocol otherwise. All nodes in the cluster must be able to receive UDP packets sent to the multicast/broadcast address. |
| multipipeMulticastPort | integer |
Number of the UDP port used for cluster communication on the slave nodes. This port needs to be accessible from the master node, i.e., it must be accepted by any installed firewalls.
Note: The multicast port number can be identical to the master port number (see above), but ideally it should be different. |
| multipipeRemoteCommand | string |
Command used to log in to slave nodes during Vrui application startup. If not specified, this defaults to ssh. |
| multipipeConnectionWaitTimeout | number |
Maximum time (in seconds) a slave node will try to establish a connection to the master node before giving up with a fatal error. |
| multipipePingTimeout | number |
Timeout value for cluster crash detection. If a slave node does not receive data from the master for the specified time (in seconds), it sends a ping request to the master. If too many ping requests time out (see next setting), the slave node exits from Vrui. |
| multipipePingRetries | integer |
Maximum number of ping requests sent by a slave node before it exits from Vrui (see previous setting). |
| multipipeReceiveWaitTimeout | number |
Maximum time (in seconds) a slave node will wait for a data packet from the master node before assuming packet loss and initiating the packet loss recovery protocol. |
| multipipeBarrierWaitTimeout | number |
Maximum time (in seconds) a slave node will wait for a barrier completion message from the master node before assuming packet loss and resending its own barrier arrival message. |
| multipipeSendBufferSize | integer |
Maximum number of packets that can be waiting in any multicast pipe's send buffer; analogous to the windowSize setting of TCP ports. Larger numbers might help increase multicast bandwidth, while smaller numbers generally decrease multicast latency. |
| inhibitScreenSaver | boolean |
Requests inhibition of the desktop environment's screen saver to avoid screen blanking or low-power states while a VR application is running. |
| inchScale | number |
Defines the physical coordinate unit used to describe the Vrui environment by specifying the length of an inch in physical units. For example, if the used physical units are meters, inchScale is set to 0.0254. |
| meterScale | number |
Defines the physical coordinate unit used to describe the Vrui environment by specifying the length of a meter in physical units. Alternative to inchScale setting, see above. For example, if the used physical units are centimeters, meterScale is set to 100.0. |
| displayCenter | point |
Defines the center point of the Vrui display environment in physical coordinates. The center point is mostly used by applications to initialize their model coordinates. In general, the display center should be a point that is in the middle of the display space accessible by users, such as the screen center for a single-screen environment or the center point of a CAVE. |
| displaySize | number |
Defines an approximate size for the Vrui display environment in physical coordinate units. The display size is mostly used by applications to initialize their model coordinates. |
| forwardDirection | vector |
Defines a direction vector in physical coordinates that corresponds to the typical direction a user would face when looking at a Vrui display environment. For single-screen environments it is typically a vector pointing into the screen; in CAVEs, it is typically a vector pointing into the back wall. |
| upDirection | vector |
Defines a direction vector in physical coordinates that corresponds to "up," i.e., the opposite direction of local gravity. It is mostly used by Vrui application to initialize their model coordinates such that models appear right side up. |
| floorPlane | plane |
Defines a plane in physical coordinates that corresponds to a Vrui display environment's floor. For walk-in environments such as CAVEs or upright display walls it is typically the true floor plane; for desktop-like environments it is typically a plane orthogonal to the "up" direction that is placed a few feet below the screen center.
The floor plane is used by some navigation tools or applications to lock the virtual floor of a virtual environment to the real floor of the real environment, to support virtual walking. |
| glyphSize | number |
Specifies the display size of glyphs such as input device pointers in physical coordinates. |
| glyphCursorFileName | string |
Specifies the name of an X cursor file containing the image to use for texture-based "fake" mouse cursors. |
| glyphCursorNominalSize | integer |
Specifies the nominal pixel size of the mouse cursor image to load from the cursor file. |
| newInputDevicePosition | point |
Specifies a point in physical coordinates that is used as the initial position for newly created virtual input devices. It is typically identical to the display center, but for single-screen environments, it is typically offset a few inches to be placed in front of the screen to simplify interaction with new virtual input devices. |
| inputDeviceAdapterNames | list of strings |
List of names of the input device adapter sections that specify all sources of user input recognized by Vrui applications. |
| inputDeviceDataSaver | string |
Name of input device data saver section. If this is a valid section name, Vrui will save the state of all physical input devices to a file on every frame. These files can later be played back by creating a playback input device adapter. Saving input device data can be useful during debugging, to capture a session and play it back later from inside a debugger, or to generate 3D movies of someone using a Vrui application. |
| updateContinuously | boolean |
Flag whether to run Vrui's inner loop continuously. If this is set to false, Vrui will only update its (and the application's state) whenever new data arrives from any input devices. This is the most appropriate mode for non-immersive display environments. If set to true, Vrui will update its internal state as fast as possible, regardless of whether new input device data arrived or not. Applications that use animation will typically override this setting to run smooth animations even if no input device events arrive, or explicitly ask for state updates whenever they change their visible state. |
| maximumFrameRate | number |
The maximum allowed frame rate for Vrui's main loop. If this parameter is set to a value larger than zero, the Vrui main loop will pad each frame to at least the duration of 1.0/maximFrameRate seconds by blocking before advancing to the next frame. Normally Vrui applications should run as fast as they can to minimize latency; however, some special uses like generating 3D movies by saving input device data (see above) might benefit from a throttled frame rate. |
| viewerNames | list of strings |
List of names of viewer sections. Viewers define how 3D models are projected onto a Vrui display environment's screens. The first viewer in the list is considered the main viewer and is treated specially, for example, is used to determine the orientation of pop-up menus. |
| screenNames | list of strings |
List of names of screen sections. Together with viewers, screens define how 3D models are projected in a Vrui display environment. |
| screenProtectorAreas | list of list of points |
A list of polygons, each defined by a list of vertices, defining the environment's accessible boundaries. If this tag is not present, the environment's boundaries will be defined by the set of screens that have the protectScreen flag set. |
| screenProtectorDevices | list of screen protector devices |
A list of input devices and associated sphere centers and radii (in device coordinates) to warn users of moving too close to the environment's configured boundaries. |
| screenProtectorGridSize | number |
Spacing between grid lines when drawing screen protectors in physical coordinate units. |
| screenProtectorGridColor | color |
Color with which to draw screen protector grids. |
node<index>WindowNames
windowNames | list of strings |
List of names of window sections. Windows are the "glue" that bind viewers to screens and implement the OpenGL-based 3D rendering used by Vrui. In cluster-based distributed display environments, there must be a node<index>WindowNames tag for each cluster node (the master node is always zero; slave nodes are numbered according to their order in the multipipeSlaves list, starting at one). Any nodes with empty window lists will not open any windows, but otherwise fully participate in the Vrui application. This is useful for cluster head nodes with low-powered graphics cards, or for dedicated audio rendering nodes. |
| listenerNames | list of strings |
List of names of listener sections. Listeners define how spatial 3D sound is rendered in a Vrui environment. The first listener in the list is considered the main listener. |
node<index>SoundContextName
soundContextName | string |
Name of a sound context section. Sound contexts correspond to audio devices and define how spatial 3D sound is rendered in a Vrui environment. In cluster-based distributed display environments, there must be a node<index>SoundContextName tag for each cluster node that is supposed to render spatial 3D sound using the OpenAL library (the master node is always zero; slave nodes are numbered according to their order in the multipipeSlaves list, starting at one). |
| frontplaneDist | number |
Defines the distance in physical units of the OpenGL front clipping plane from the eye points of Vrui viewers. This defines how closely a viewer can approach 3D objects before the objects are clipped away. |
| backplaneDist | number |
Defines the distance in physical units of the OpenGL back clipping plane from the eye points of Vrui viewers. This defines how far a 3D object can move into the distance before it is clipped away. |
| backgroundColor | color |
Defines the background color used for all windows in a Vrui display environment, unless overridden by Vrui applications. |
| foregroundColor | color |
Defines a color that contrasts well with the selected backgroundColor, to be used by Vrui components and applications to render HUD elements and such. Defaults to the complementary color of the selected background color. |
| ambientLightColor | color |
Defines the ambient color component used in the OpenGL lighting equation. This is the light color used when no other lights are present. It should be kept at fairly low values not to wash out display contrast. |
| widgetMaterial | material |
Defines the material properties of 3D GUI widgets such as pop-up menus, dialog windows, etc. |
| drawOverlayWidgets | boolean |
Switches whether 3D user interface widgets are drawn in an overlay layer above all other 3D graphics. If disabled (the default), 3D widgets are integrated with other 3D graphics and drawn at the proper depth. If enabled, widgets are still drawn at proper depth, but appear to float above other graphics. This makes the user interface more desktop-like and works well in non-stereo mode, but can cause severe eye strain in stereo modes on the desktop and especially in immersive environments. |
| uiSize | number |
Defines a size in physical units used for general layout of 3D GUI widgets, such as border widths, text field margins, etc. |
| uiBgColor | color |
Default background color for GLMotif UI components. |
| uiFgColor | color |
Default foreground color for GLMotif UI components. |
| uiTextFieldBgColor | color |
Default background color for GLMotif text fields. |
| uiTextFieldFgColor | color |
Default foreground color for GLMotif text fields. |
| uiSelectionBgColor | color |
Default background color for selected text in GLMotif UI components. |
| uiSelectionFgColor | color |
Default foreground color for selected text in GLMotif UI components. |
| uiTitleBarBgColor | color |
Default background color for title bars in GLMotif popup windows. |
| uiTitleBarFgColor | color |
Default foreground color for title bars in GLMotif popup windows. |
| uiFontName | string |
Name of the font used for 3D UI widgets such as labels, buttons, or text fields. Vrui uses its own texture-based fonts which are installed in the share/GLFonts directory. |
| uiFontTextHeight | number |
Defines the height of text for 3D UI widgets in physical units. |
| uiFontAntialiasing | boolean |
Toggles font smoothing for 3D UI widgets. Should be enabled if text looks "pixellated." |
| uiSliderWidth | number |
Width of slider handles in GLMotif sliders in physical units. |
| uiSliderHandleColor | color |
Color of slider handles in GLMotif sliders. |
| uiSliderShaftColor | color |
Color of slider shafts in GLMotif sliders. |
| pointPickDistance | number |
Maximum "fudge" distance for a point-based 3D pick request. |
| rayPickAngle | number |
Maximum "fudge" angle in degrees for a ray-based 3D pick request. |
| animationFrameInterval | number |
Suggested frame time interval for general-purpose animations. |
| uiManager | string |
Name of UI manager section. The UI manager is responsible for arranging 2.5D UI components in physical space. |
| tools | string |
Name of tool manager section. The tool manager is responsible for translating low-level input device events such as button presses into higher-level application functions such as navigation. |
| vislets | string |
Name of vislet manager section. Vislets are additional rendering modules that can be loaded into arbitrary Vrui applications as plug-ins. |
If the name of an input device configuration file section matches the name of a virtual input device defined by the connected VR device daemon, all settings except deviceGlyphType and deviceGlyphMaterial are ignored, and their values are instead taken from the virtual input device descriptor received from the VR device daemon.
| Setting Tag | Setting Value Type | Setting Description |
|---|
| inputDeviceDataFileName | string |
Name of the input file from which to read input device data. The file must have been created by saving input device data from a previous run of the same Vrui application, in the exact same environment; otherwise, results are undefined. |
| preTransform | orthogonal transformation |
Optional transformation applied from the left to stored input device tracking data. |
| device<index>GlyphType | glyph type |
Type of glyph used to draw a 3D representation of the input device of the given zero-based index in the Vrui display environment. |
| device<index>GlyphMaterial | material |
Material properties to render the device glyph of the given zero-based index. |
| fakeMouseCursorDevice | integer |
If set to a valid input device index from the loaded input device file, enables a texture-based mouse cursor to be rendered at the position of the selected input device. This is useful when playing back sessions recorded in mouse-controlled environments, since otherwise the mouse cursor would not show up. |
| mouseCursorImageFileName | string |
The name of the cursor image file from which to load the fake mouse cursor, if enabled. |
| mouseCursorNominalSize | integer |
The nominal size of the mouse cursor which is to be loaded from the cursor image file. Nominal sizes are defined in the cursor file itself, and Vrui selects the most closely matching size from the file. |
| mouseCursorSize | size |
Size of the rendered mouse cursor glyph in physical coordinates. The third component of the given value is ignored. |
| mouseCursorHotspot | vector |
Offset from the bottom-left corner of the mouse cursor image to the cursor "hotspot," i.e., the position that corresponds to the mouse position. Normalized to lie within [0, 1] in both directions; the third component of the given value is ignored. |
| synchronizePlayback | bool |
When this flag is set to true, the playback input device adapter will synchronize the timing of Vrui application frames with the time stamps stored in its input file. As a result, the playback should run exactly at the same speed as the original recording. |
| quitWhenDone | bool |
When this flag is set to true, the playback input device adapter will shut down the Vrui application after reading its entire input file. |
| soundFileName | string |
Name of a sound file to be played in synchronization with the input device data. The sound file must have been recorded by the input device data saver in the same session as the input device data file. |
| saveMovie | bool |
When this flag is set to true, the playback input device adapter will create a movie by saving a sequence of screen shots from a specified window on the master node, exactly at specified intervals. |
| movieFileNameTemplate | string |
Printf-style format string to generate image file names for the screenshots written while generating a movie. The template must contain exactly one integer conversion specifier, of the form %[0-9]*d. |
| movieWindowIndex | integer |
The index of the master node window from which to save screenshots for a movie. This integer must be a valid index in the master node's list of windows; saving movie screenshots from a window on a slave node is not yet supported. |
| movieFrameRate | number |
Target frame rate for the exported movie. The playback input device adapter will export slices at exactly the specified times to guarantee real-time playback even if Vrui's main loop frame rate varies. Movie frames will point sample the sequence of Vrui frames: short Vrui frames might be skipped and not generate movie frames, and long Vrui frames might generate multiple identical movie frames. |
| movieSkipFrames | integer |
Number of initial frames to skip when saving a movie. Defaults to 0. |
| movieFirstFrameIndex | integer |
The index to assign to the first saved movie frame after initial frames have been skipped. Defaults to 0. |
| Setting Tag | Setting Value Type | Setting Description |
|---|
| name | string |
Name of the screen used by Vrui itself, and visible to Vrui applications. Defaults to the name of the configuration file section. |
| deviceMounted | boolean |
Toggles whether the screen is attached to an input device (such as head-mounted displays) or at a fixed position/orientation in physical coordinates. |
| deviceName | string |
If deviceMounted is true, gives the name of the input device the screen is attached to. |
| transform | tracker state |
Directly specifies the screen's transformation with respect to physical space (if deviceMounted is false) or to local device space (if deviceMounted is true). If this tag does not exist, Vrui uses the origin, horizontalAxis, and verticalAxis tags instead. |
| origin | point |
Defines the origin (lower-left corner in pixel coordinates) of the screen in physical coordinates (if deviceMounted is false) or in local device coordinates (if deviceMounted is true). |
| horizontalAxis | vector |
Direction of the screen's horizontal axis (left to right in pixel coordinates) in physical coordinates (if deviceMounted is false) or in local device coordinates (if deviceMounted is true). |
| width | number |
Width of the screen in physical units. |
| verticalAxis | vector |
Direction of the screen's vertical axis (bottom to top in pixel coordinates) in physical coordinates (if deviceMounted is false) or in local device coordinates (if deviceMounted is true). |
| height | number |
Height of the screen in physical units. |
| rotateCenter | point |
Defines the center point of an additional rotation that can be used to easily rotate a screen around any desired axis (such as in adjustable workbenches or flexible CAVEs). |
| rotateAxis | vector |
Axis of an additional rotation around the center point defined by the rotateCenter tag. |
| rotateAngle | number |
Angle of additional screen rotation in degrees. |
| preTransform | tracker state |
An arbitrary orthonormal transformation (translation + rotation) to move the screen's position and orientation in physical space (if deviceMounted is false) or in local device space (if deviceMounted is true). |
| offAxis | boolean |
Flag whether the screen is projected off-axis, i.e., requires a correction homography. |
| homography | 3x3 matrix |
A 3x3 matrix defining a homography in screen space, which transforms the screen's theoretical rectangle into the screen's projected quadrilateral. |
| intersect | boolean |
Flag whether the screen is considered for intersection tests in screen-based UI methods. |
| protectScreen | boolean |
Flag whether this screen's display area will be included in the definition of the environment's boundaries (also see screenProtectorAreas tag). |
| Setting Tag | Setting Value Type | Setting Description |
|---|
| viewerName | string |
Name of the viewer associated with this window. |
leftViewerName
rightViewerName | string |
Pair of tags to specify different viewers handling the window's left and right eyes, respectively. These tags are only useful for one very specific purpose, and should generally not be used. |
| screenName | string |
Name of the screen associated with this window. |
leftScreenName
rightScreenName | string |
Pair of tags to specify different screens handling the window's left and right eye views. This is necessary in some specific circumstances, such as in head-mounted displays. |
| display | string |
Name of the X11 display to use for this window; defaults to the local display defined by the DISPLAY environment variable. |
| screen | integer |
Zero-based index of the X11 screen on the window's X11 display to which to direct this window. If not specified, defaults to the X11 connection's default screen, i.e., the .X part of the display name. |
| outputName | string |
Name of an output, i.e., a video signal connector or connected monitor, on the graphics adapter associated with the window's X display, on which the window should be placed, and inside whose pixel area the window is panned if panningViewport is true. |
| groupId | integer |
ID of the window group to which this window belongs. Windows inside the same group share OpenGL contexts and OpenGL data and a rendered in sequence; separate groups are rendered in parallel from individual threads. Group IDs are local to each node in a Vrui cluster. |
| windowSize | window size |
Initial size of the window's interior on the display in pixel units. This is only a request to the window manager, which might disallow certain placements. |
| windowPos | window position |
Initial position of the window's interior on the display in pixel coordinates. The position component places the top-left corner of the window's interior, with (0, 0) corresponding to the top-left corner of the screen. This is only a request to the window manager, which might disallow certain placements. |
| decorate | boolean |
Flag whether to put window manager decorations (title bar, frame, buttons) around the window. This is only a request to the window manager, but is generally granted. |
| bypassCompositor | boolean |
Flag whether to bypass desktop compositing for this window, to reduce rendering latency. This is only a request to the window manager, and might not be granted. |
| windowFullscreen | boolean |
Flag whether to initially maximize the window (removing all window decoration and screen borders). |
| useBackBuffer | boolean |
Flag whether to force double-buffered rendering in this window, even if the window type and other settings would allow front-buffer rendering. |
| vsync | boolean |
Flag whether to enable vertical retrace synchronization on this window, for tear-free rendering and smooth frame rates at the cost of increased latency. |
| lowLatency | boolean |
Flag whether to reduce display latency if vsync is enabled, at the cost of the CPU busy-waiting for the vertical retrace period. |
| preSwapDelay | number |
If front-buffer rendering, number of milliseconds before the vertical retrace signal to start the final lens distortion correction rendering pass for tear-free and smooth rendering. Requires the optional GLX_NV_delay_before_swap OpenGL extension. |
| windowType | enumerant |
- Mono
- Monoscopic window; uses the associated viewer's monoscopic eye position.
- LeftEye
- Left-eye view only; uses the associated viewer's left eye position.
- RightEye
- Right-eye view only; uses the associated viewer's right eye position.
- AnaglyphicStereo
- Stereoscopic rendering using anaglyphic (red/blue color separation) stereo.
- SplitViewportStereo
- Stereoscopic rendering using two separate viewports in the same window, such as side-by-side stereo. The two used viewports can be exactly specified using the leftViewportPos and rightViewportPos settings.
- InterleavedViewportStereo
- Stereoscopic rendering using two interleaved viewports in the same window, for example by using even pixel columns for the left eye, and odd pixel columns for the right eye. This is the stereo mode often supported by commodity stereoscopic displays like 3D DLP televisions, or polarizing flat panel monitors. The interleaving pattern can be specified via the interleavePattern tag.
- QuadbufferStereo
- Stereoscopic rendering using a quad-buffered visual (also known as "active" stereo). Typically only supported by professional-level graphics cards such as Nvidia Quadros.
|
| leftViewportPos | window position |
Position of the viewport used for left-eye views in SplitViewportStereo stereo mode in window coordinates. |
| rightViewportPos | window position |
Position of the viewport used for right-eye views in SplitViewportStereo stereo mode in window coordinates. |
| interleavePattern | string |
Interleave pattern for InterleavedViewportStereo stereo mode. The string must be four characters long and consist only of the characters L and R, either uppercase or lowercase. The string defines a 2x2 pixel tile in order top to bottom and left to right, where L or R indicate that the corresponding pixels belongs to the left or right eye, respectively. |
| multisamplingLevel | integer |
Level of OpenGL multisampling to use for the window. Support for this feature, and the available level numbers, are dependent on the model of installed graphics card. |
| lensCorrectorName | string |
Name of the lens correction configuration section for this window, defining parameters for lens distortion correction as required for commodity head-mounted displays. |
| mouseScreenName | string |
Name of a screen used to project the mouse cursor position into 3D space. If not specified, this defaults to the screen associated with the viewport of the window currently containing the mouse cursor. Using a mouse screen helps improve mouse interaction specifically on split-viewport stereo windows. |
| autoScreenSize | boolean |
If set to true, instructs the window to query the physical size of its associated X11 screen, and override the configured size of its associated VR screen with the found values. If the X11 server is configured correctly, this will result in accurate physical units in the display window for any connected monitor. |
| panningViewport | boolean |
Flag determining the relationship between the display screen containing a window and the Vrui screen describing the window's position in physical space. If this flag is set to false (the default), the associated Vrui screen is always fully mapped to the window's current position and size. If the flag is true, the Vrui screen is considered to map to the display screen containing the window instead. In effect, this means that the window serves as a sliding viewport into the 3D environment as seen through the screen. Moving or resizing a window with a panning viewport will not affect the position or size of the shown model. |
| panningDomain | window position |
Overrides a window's panning domain if panningViewport is true. By default, a window's panning domain is the entire X screen. Explicitly specifying a panning domain, and disabling autoScreenSize, makes it possible to use panning windows in multi-monitor setups where the monitor's resolutions (in pixels/length unit) do not match. |
| navigate | boolean |
Flag defining the effect of moving or resizing a panning-viewport window on the displayed 3D scene. If this flag is true, moving the window will move the 3D scene, and resizing the window will scale the 3D scene using a "fake" navigation tool. In effect, navigation will make a Vrui window behave almost exactly like a 3D window in desktop-centric applications, but the 3D scene will still be projected from the correct viewpoint to provide, for example, correct stereoscopic rendering. |
| movePrimaryWidgets | boolean |
Flag to move popped-up primary widgets along with a panning-viewport window when it is moved or resized. |
| toolKillZonePos | window point |
Setting to override the position of the tool kill zone when moving/resizing panning-viewport windows. By default, the position of the tool kill zone is given in physical coordinates and does not move with the window. If this tag is set, the tool kill zone will always stay at the given relative window coordinates. Relative window coordinates map (0, 0) to the lower-left window corner and (1, 1) to the top-right window corner. |
| exitKey | qualified key name |
Key that terminates the Vrui application without confirmation. Defaults to Esc. |
| homeKey | qualified key name |
Key that resets the navigation transformation to the application-defined default. Defaults to Super+Home. |
| screenshotKey | qualified key name |
Key to request a screenshot from this Vrui window. Defaults to Super+Print. |
| fullscreenToggleKey | qualified key name |
Key to toggle the Vrui window between windowed and fullscreen mode. Defaults to F11. |
| burnModeToggleKey | qualified key name |
Key to switch the Vrui window into and out of "burn mode," in which frames are generated and rendered as quickly as possible to calculate the performance of the Vrui application. Defaults to Super+ScrollLock. |
| saveMovie | boolean |
Flag to enable saving the contents of this window as a movie, either as a sequence of frames or directly as an Ogg/Theora video file. |
| movieSaveTheora | boolean |
Flag to save movies in Ogg/Theora format instead of a sequence of frame images. |
| movieFileName | string |
Name of Ogg/Theora video file to create. |
| movieBitRate | integer |
Bitrate for Ogg/Theora compressor. If set to a non-zero value, compressor will use constant bit rate encoding. |
| movieQuality | integer |
Variable bit rate encoding quality for Ogg/Theora compressor. |
| movieGopSize | integer |
Keyframe distance for Ogg/Theora compressor. |
| movieFrameNameTemplate | string |
Printf-style name template for movie frame images when not saving to an Ogg/Theora video file. The format string must contain exactly one %u placeholder, and no other placeholders. |
| movieFrameRate | number |
Desired movie frame rate in frames/second. |
| movieSoundFileName | string |
Name of sound file to record while saving a movie. If not specified, no sound will be recorded. |
| movieSoundDeviceName | string |
Name of sound device from which to record. If not specified, recorder will use system's default sound device. |
| movieSampleResolution | integer |
Sample resolution for sound recording in bits. |
| movieNumChannels | integer |
Number of channels for sound recording. |
| movieSampleRate | integer |
Sample rate for sound recording in Hertz. |
| showFps | boolean |
Flag to display the current (filtered) Vrui frame rate in the window. Frame rates are only displayed while the Vrui application is in "burn mode." |
| showFpsFontName | string |
Name of the font used to display the current frame rate in the window. Vrui uses its own texture-based fonts which are installed in the share/GLFonts directory. |
| joinSwapGroup | boolean |
Flag whether a window should become part of a swap group (deprecated feature only available on some Nvidia graphics cards). |
| swapGroupName | integer |
Numeric identifier of the swap group the window should join (deprecated feature only available on some Nvidia graphics cards). |
| swapBarrierName | integer |
Numeric identifier of the swap barrier on which the window should wait before swapping buffers (deprecated feature only available on some Nvidia graphics cards). |
| Setting Tag | Setting Value Type | Setting Description |
|---|
| lensCenterDist | number |
Distance between the centers of the left and right lenses, in physical coordinate units. Used to generate default lens center positions. Default value is 2.5". |
| lensScreenDist | number |
Distance from screen surface to the surface of the left and right lenses, in physical coordinate units. Used to generate default lens center positions. Default value is the smaller of the widths of the window's left and right screens. |
| lensFocalLength | number |
Focal length of both lenses in Vrui physical units. Default value is 2.5". |
| lensProjectionDist | number |
Distance from projected virtual screen surface to the surface of the left and right lenses, in physical coordinate units. |
leftLensCenter
rightLensCenter | point |
3D positions of the left/right lenses' centers, in screen coordinates of the window's left/right screens, respectively. Default values are based on lensCenterDist, lensScreenDist, and the vertical center points of the windows left/right screens, respectively. |
leftLensFocalLength
rightLensFocalLength | point |
Focal lengths of the left and right lenses, respectively. |
leftLensProjectionDist
rightLensProjectionDist | number |
Projection distances for the virtual left and right screens, respectively. Used to automatically create virtual screens based on window's real screens. |
leftFormulaNames
rightFormulaNames | list of exactly three strings |
List of names of distortion function sections for the left/right lenses, respectively, in the order green-channel distortion function, red-channel distortion modulation function, blue-channel distortion modulation function. |
leftOverscan
rightOverscan | list of exactly four numbers |
List of left, right, bottom, and top overscan factors for the left/right lenses, respectively, accounting for increased FOV due to lens magnification. Default values are (0.0, 0.0, 0.0, 0.0) for no overscan. |
| projectScreens | boolean |
Flag whether to override the window's specified left and right screens with virtual versions projected by the left and right lenses, respectively. |
| superSampling | number |
Magnification factor for the pre-distortion render buffer for super-sampling antialiasing. Defaults to 1.0 for no super-sampling. |
| warpMeshSize | list of exactly two integers |
List of integers not smaller than one defining the number of columns and rows in the lens correction warp mesh, respectively. Default value is (64, 64). |
| warpReproject | boolean |
Flag whether to use reprojection during warp to reduce apparent display latency. Defaults to true. |
| warpCubicLookup | boolean |
Flag whether to use cubic interpolation when re-sampling a pre-distortion render image into the final window during lens distortion correction. Defaults to false. |
| displayRotation | number |
Rotation angle for the display rendered into by the lens corrector, in degrees in 90 degree increments. When using display correction, the window size gives the true (unrotated) size and position of the window, and the screen positions, dimensions, and orientations are unrotated in physical or HMD device space. |
| oledCorrectionFactors | list of exactly two numbers |
"Overdrive" correction factors to account for OLED pixels' non-instantaneous switch times. The first number is the overdrive factor applied to pixels of increasing brightness, the second is the factor applied to pixels of decreasing brightness. Default value is (0.0, 0.0) for no overdrive correction. |
| fixContrast | boolean |
Flag to enable or disable automatic contrast reduction when OLED overdrive correction is enabled. Default value is true. |
In addition to the above tag/value pairs, tool binding sections can contain any subset of the configuration tag/value pairs understood by the tool class used in the binding. Tool class setting tag/value pairs provided in a tool binding section override the values of the same configuration tags given in that tool class' configuration section.