VR & XR Development
VR Console Commands and Variables

VR Console Commands and Variables

Common VR Settings#

vr_info
Description: Command. Prints the information on the current VR API and the connected VR devices — HMD, controllers, and others. For the controllers, it also displays the battery level (if available).
vr_debug_mode	^{Config file: *.boot}
Description: Variable. Prints the current debug mode for VR API. Command. Sets the debug mode for VR API. Notice When the debug mode is enabled, a severe slowdown may occur.	Arguments: 0 - release VR context (no debug) (by default) 1 - debug VR context 2 - debug VR context with break on error (only on debug binaries)
vr_reset_zero_pose
Description: Command. Sets the zero pose to the current tracker position.
vr_render_enabled	^{Config file: *.boot}
Description: Variable. Prints a value indicating if the option controlled by the command below is enabled. Command. Toggles the value indicating if rendering into the head-mounted display is enabled.	Arguments: 0 - disabled (by default) 1 - enabled
vr_peripheral_rendering_mode_enabled	^{Config file: *.boot}
Description: Variable. Prints a value indicating if the option controlled by the command below is enabled. Command. Toggles the value indicating if the peripheral rendering mode is enabled. In this mode, the HMD has two context (peripheral) and two focus displays. You can disable two additional viewports to improve peformance. Notice This feature is available for the Varjo devices only.	Arguments: 0 - disabled (by default) 1 - enabled
vr_service_init_timeout	^{Config file: *.boot}
Description: Variable. Prints the current VR initialization timeout in number of attempts. The engine attempts to run VR Service and has to wait for its initialization. Command. Sets the VR initialization timeout in number of attempts. The engine attempts to run VR Service and has to wait for its initialization.	Arguments: [0; 200] - available range 60 - by default
vr_mirror_mode	^{Config file: *.boot}
Description: Variable. Prints the current mirror mode that defines how the mirrored image (i.e. VR image) will be displayed in the target window. Command. Sets the mirror mode that defines how the mirrored image (i.e. VR image) will be displayed in the target window.	Arguments: 0 - black screen (no image is displayed). 1 - image rendered for the left eye. 2 - image rendered for the right eye. 3 - stereo image (both the left and right eyes). (by default)
vr_window_mode	^{Config file: *.boot}
Description: Variable. Prints the current window mode that defines which window will display the mirrored image (i.e. VR image). Command. Sets the window mode that defines which window will display the mirrored image (i.e. VR image).	Arguments: 0 - mirroring is disabled. 1 - main window displays the mirrored image. (by default)
vr_tracking_space	^{Config file: *.boot}
Description: Variable. Prints the current zero pose of the tracking origin. Command. Sets the zero pose of the tracking origin.	Arguments: 0 - seated. 1 - standing. (by default) 2 - raw (uncalibrated).
vr_head_tracking_position_enabled	^{Config file: *.boot}
Description: Variable. Prints a value indicating if the option controlled by the command below is enabled. Command. Toggles the value indicating if the head position is locked.	Arguments: 0 - disabled 1 - enabled (by default)
vr_head_tracking_rotation_enabled	^{Config file: *.boot}
Description: Variable. Prints a value indicating if the option controlled by the command below is enabled. Command. Toggles the value indicating if the head rotation is locked.	Arguments: 0 - disabled 1 - enabled (by default)
vr_motion_prediction	^{Config file: *.boot}
Description: Variable. Prints a value indicating if the option controlled by the command below is enabled. Command. Toggles the value indicating if motion prediction in the Varjo headsets is enabled. When enabled, the engine submits the velocity value from the GBuffer to the Varjo Composer.	Arguments: 0 - disabled (by default) 1 - enabled
vr_motion_prediction_velocity_precision	^{Config file: *.boot}
Description: Variable. Prints the current factor of velocity scale before packing a floating point value into a 2x8 bit unsigned integer (uint). Notice This feature is available for the Varjo devices only. Command. Sets the factor of velocity scale before packing a floating point value into a 2x8 bit unsigned integer (uint). Notice This feature is available for the Varjo devices only.	Arguments: [eps; inf] - available range 32.0f - by default
vr_motion_prediction_velocity_time_delta	^{Config file: *.boot}
Description: Variable. Prints the current factor for optimizing between fast and slow-moving objects. A smaller number works better for fast-moving objects, and vice versa. Notice This feature is available for the Varjo devices only. Command. Sets the factor for optimizing between fast and slow-moving objects. A smaller number works better for fast-moving objects, and vice versa. Notice This feature is available for the Varjo devices only.	Arguments: [eps; inf] - available range 1.0f / 60.0f - by default
vr_foveated_rendering_enabled	^{Config file: *.boot}
Description: Variable. Prints a value indicating if the option controlled by the command below is enabled. Command. Toggles the value indicating if foveated rendering is enabled. Foveated rendering makes use of the eye tracking functionality in the Varjo headsets to improve performance by reducing the image quality in peripheral areas where the user is not looking. Foveation allows applications to render fewer pixels and achieve a better VR experience. Notice This feature is available for the Varjo devices only.	Arguments: 0 - disabled 1 - enabled (by default)

Mixed Reality Settings#

vr_mixed_reality_chroma_key_enabled
Description: Variable. Prints a value indicating if the option controlled by the command below is enabled. Command. Toggles the value indicating if chroma keying is enabled. VST capturing from HMD cameras must be enabled.	Arguments: 0 - disabled (by default) 1 - enabled
vr_mixed_reality_depth_test_enabled
Description: Variable. Prints a value indicating if the option controlled by the command below is enabled. Command. Toggles the value indicating if depth buffer submission is enabled. VST capturing from HMD cameras must be enabled.	Arguments: 0 - disabled (by default) 1 - enabled
vr_mixed_reality_alpha_blend_enabled
Description: Variable. Prints a value indicating if the option controlled by the command below is enabled. Command. Toggles the value indicating if alpha blending is enabled. This option is used for blending VR and AR images using the alpha channel. VST capturing from HMD cameras must be enabled and the screen precision must be 1.	Arguments: 0 - disabled (by default) 1 - enabled
vr_mixed_reality_video_enabled
Description: Variable. Prints a value indicating if the option controlled by the command below is enabled. Command. Toggles the value indicating if the video signal from the real-world view from the front-facing HMD-mounted cameras is enabled. The real-world view is used for combining virtual and real-world elements to create an immersive experience in mixed reality.	Arguments: 0 - disabled (by default) 1 - enabled
vr_mixed_reality_depth_test_range_enabled
Description: Variable. Prints a value indicating if the option controlled by the command below is enabled. Command. Toggles the value indicating if the depth test range usage is enabled. Use the depth test range (Depth Test Near Z, Depth Test Far Z) to control the range for which the depth test is evaluated.	Arguments: 0 - disabled (by default) 1 - enabled
vr_mixed_reality_depth_test_range
Description: Variable. Prints the current depth test range as a two-component vector (the near and far planes). The depth test range usage must be enabled. Command. Sets the depth test range as a two-component vector (the near and far planes). The depth test range usage must be enabled.	Arguments: vec2(0.0f, 1.0f) - default value
vr_mixed_reality_camera_exposure_time	^{Config file: *.boot}
Description: Variable. Prints the current exposure time value that is valid for the connected device. Command. Sets the exposure time value that is valid for the connected device.	Arguments: 1 - exposure time value equal to 91 ms 2 - exposure time value equal to 125 ms (default) 3 - exposure time value equal to 250 ms 4 - exposure time value equal to 500 ms 5 - exposure time value equal to 1000 ms 6 - exposure time value equal to 2000 ms 7 - exposure time value equal to 4000 ms 8 - exposure time value equal to 8000 ms
vr_mixed_reality_camera_exposure_time_mode
Description: Variable. Prints the current exposure adjustment mode for the camera. Command. Sets the exposure adjustment mode for the camera.	Arguments: 0 - exposure adjustment is disabled 1 - automatic exposure adjustment (by default) 2 - manual exposure adjustment
vr_mixed_reality_camera_white_balance	^{Config file: *.boot}
Description: Variable. Prints the current white balance correction value that is valid for the connected device. Command. Sets the white balance correction value that is valid for the connected device.	Arguments: 1 - white balance value equal to 2000 K 2 - white balance value equal to 3000 K 3 - white balance value equal to 3500 K 4 - white balance value equal to 4200 K 5 - white balance value equal to 5000 K 6 - white balance value equal to 5400 K 7 - white balance value equal to 6500 K (default) 8 - white balance value equal to 8000 K 9 - white balance value equal to 12000 K
vr_mixed_reality_camera_white_balance_mode
Description: Variable. Prints the current white balance adjustment mode for the camera. Command. Sets the white balance adjustment mode for the camera.	Arguments: 0 - white balance adjustment is disabled 1 - automatic white balance adjustment (by default) 2 - manual white balance adjustment
vr_mixed_reality_camera_iso	^{Config file: *.boot}
Description: Variable. Prints the current ISO value for the camera. Command. Sets the ISO value for the camera.	Arguments: 1 - ISO value equal to 100 2 - ISO value equal to 200 3 - ISO value equal to 400 4 - ISO value equal to 800 (default) 5 - ISO value equal to 1600 6 - ISO value equal to 3200 7 - ISO value equal to 6400
vr_mixed_reality_camera_iso_mode
Description: Variable. Prints the current ISO adjustment mode for the camera. Command. Sets the ISO adjustment mode for the camera.	Arguments: 0 - ISO adjustment is disabled 1 - automatic ISO adjustment (by default) 2 - manual ISO adjustment
vr_mixed_reality_camera_flicker_compensation
Description: flicker compensation value for the camera. This is useful when using the HMD indoors with mostly artificial light bulbs, which flicker at the frequency of 50Hz or 60Hz and can cause visual flicker artifacts on the video see through image. The correct setting depends on the underlying power grid's frequency. For example, in most parts of Africa/Asia/Australia/Europe the frequency is 50 Hz and in most parts of North and South America 60 Hz.
vr_mixed_reality_camera_sharpness
Description: Variable. Prints the current sharpness filter power value for the camera. Command. Sets the sharpness filter power value for the camera.	Arguments: [0; 10] - available range 0 - by default
vr_mixed_reality_view_offset
Description: Variable. Prints the current eyes view offset (where eye camera should be positioned when using Mixed Reality): 0 for physical eye position 1 for VST camera position Command. Sets the eyes view offset (where eye camera should be positioned when using Mixed Reality): 0 for physical eye position 1 for VST camera position	Arguments: [0.0; 1.0] - available range 0.0 - by default
vr_mixed_reality_marker_tracking_enabled
Description: Variable. Prints a value indicating if the option controlled by the command below is enabled. Command. Toggles the value indicating if marker tracking is enabled.	Arguments: 0 - disabled (by default) 1 - enabled
vr_mixed_reality_marker_visualizer_enabled	^{Config file: *.boot}
Description: Variable. Prints a value indicating if the option controlled by the command below is enabled. Command. Toggles the value indicating the marker visualizer is enabled.	Arguments: 0 - disabled (by default) 1 - enabled
vr_mixed_reality_blend_masking_mode
Description: Variable. Prints the current mode of the Blend Control Mask that can be used to extend or restrict the chroma key mask or to control the depth testing against the estimated video depth. Command. Sets the mode of the Blend Control Mask that can be used to extend or restrict the chroma key mask or to control the depth testing against the estimated video depth.	Arguments: 0 - Disabled (masking mode is disabled). (by default) 1 - Restrict Video to Mask (show the video pass-through image (VST) in the mask; can be used with chroma key) 2 - Restrict VR to Mask (show VR in the mask; can be used with chroma key) 3 - Restrict VR to Chromakey reduced by Mask (show VR in the mask and chroma elsewhere; requires chroma key)
vr_mixed_reality_blend_masking_debug_enabled
Description: Variable. Prints a value indicating if the option controlled by the command below is enabled. Command. Toggles the value indicating if blend masking debug visualization is enabled. The blend masking mode must be enabled.	Arguments: 0 - disabled (by default) 1 - enabled
vr_mixed_reality_cubemap_mode
Description: Variable. Prints the current mode defining the way the AR texture is set for the environment. Command. Sets the mode defining the way the AR texture is set for the environment.	Arguments: 0 - cubemap streaming from AR cameras is disabled. 1 - environment texture substitutes the sky. 2 - the first environment preset defines the way the AR texture is set for the environment. (by default) 3 - the second environment preset defines the way the AR texture is set for the environment. 4 - the third environment preset defines the way the AR texture is set for the environment.
vr_mixed_reality_cubemap_ggx_quality
Description: Variable. Prints the current quality of the generated GGX mips for the AR cubemap. Command. Sets the quality of the generated GGX mips for the AR cubemap.	Arguments: 0 - low 1 - medium (by default) 2 - high 3 - ultra
vr_mixed_reality_override_color_correction_mode
Description: Variable. Prints the current color correction mode for the stream from the AR cameras. Command. Sets the color correction mode for the stream from the AR cameras.	Arguments: 0 - correction is disabled. (by default) 1 - exposure correction for the stream from the AR cameras. 2 - exposure and white balance correction for the stream.
vr_mixed_reality_camera_vst_reprojection_mode
Description: Variable. Prints the current reprojection mode of VST. Command. Sets the reprojection mode of VST.	Arguments: 0 - reprojection of VST is disabled (default). (by default) 1 - automatic reprojection mode of VST (the Depth buffer is used for reprojection) 2 - manual reprojections mode of VST
vr_mixed_reality_camera_vst_reprojection_distance
Description: Variable. Prints the current static distance in meters used to shift the whole image. Is configured only if the VST reprojection mode is set to Manual. Command. Sets the static distance in meters used to shift the whole image. Is configured only if the VST reprojection mode is set to Manual.	Arguments: [0.0f; 1000.0f] - available range 0.0f - by default

Hand Tracking Settings#

vr_hand_tracking_show_basis	^{Config file: *.boot}
Description: Variable. Prints a value indicating if the option controlled by the command below is enabled. Command. Toggles the value indicating if the visualizer for the basis of each hand bone is enabled. This option requires the hand visualizer to be enabled.	Arguments: 0 - disabled (by default) 1 - enabled
vr_hand_tracking_show_bone_sizes	^{Config file: *.boot}
Description: Variable. Prints a value indicating if the option controlled by the command below is enabled. Command. Toggles the value indicating if the visualizer for the size of each hand bone is enabled. This option requires the hand visualizer to be enabled.	Arguments: 0 - disabled (by default) 1 - enabled
vr_hand_tracking_show_velocity	^{Config file: *.boot}
Description: Variable. Prints a value indicating if the option controlled by the command below is enabled. Command. Toggles the value indicating if the visualizer for the velocity vectors of each hand bone is enabled. This option requires the hand visualizer to be enabled.	Arguments: 0 - disabled (by default) 1 - enabled
vr_hand_tracking_visualizer_enabled	^{Config file: *.boot}
Description: Variable. Prints a value indicating if the option controlled by the command below is enabled. Command. Toggles the value indicating if the visualizer for hands is enabled. This option requires the visualizer mode to be enabled.	Arguments: 0 - disabled (by default) 1 - enabled

Last update: 2024-10-16

Help improve this article

Was this article helpful?

Report a problem related to this article

(or select a word/phrase and press Ctrl+Enter)

VR Console Commands and Variables

In This Article:

Common VR Settings#

Mixed Reality Settings#

Hand Tracking Settings#