engine.vr Functions
Warning
The scope of applications for UnigineScript is limited to implementing materials-related logic (material expressions, scriptable materials, brush materials). Do not use UnigineScript as a language for application logic, please consider C#/C++ instead, as these APIs are the preferred ones. Availability of new Engine features in UnigineScript (beyond its scope of applications) is not guaranteed, as the current level of support assumes only fixing critical issues.
The base class for managing virtual reality in UNIGINE.
VR Initialization#
By default, VR is not initialized. To run the engine with VR, you need to specify the -vr_app command-line option on the application start-up.
Supported Graphics APIs#
The following graphics APIs are supported out of the box:
- DirectX 12
- Vulkan
VR Class
Members
void setRenderEnabled ( int enabled = 0 ) #
Console: vr_render_enabled
Sets a new value indicating if rendering into the head-mounted display is enabled. This parameter is stored in the following configuration file: *.boot .
Arguments
- int enabled - The rendering into the HMD The default value is false.
int isRenderEnabled() const#
Console: vr_render_enabled
Returns the current value indicating if rendering into the head-mounted display is enabled. This parameter is stored in the following configuration file: *.boot .
Return value
Current rendering into the HMD The default value is false.void setPeripheralRenderingModeEnabled ( int enabled = 1 ) #
Console: vr_peripheral_rendering_mode_enabled
Sets a new 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. This parameter is stored in the following configuration file: *.boot .
Arguments
- int enabled - The the peripheral rendering mode The default value is true.
int isPeripheralRenderingModeEnabled() const#
Console: vr_peripheral_rendering_mode_enabled
Returns the current 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. This parameter is stored in the following configuration file: *.boot .
Return value
Current the peripheral rendering mode The default value is true.void setPeripheralRenderingDebugEnabled ( bool enabled = 1 ) #
Sets a new value indicating if debug visualization for peripheral rendering is enabled. This parameter is stored in the following configuration file: *.boot .
Arguments
- bool enabled - Set true to enable debug visualization for peripheral rendering; false - to disable it. The default value is true.
bool isPeripheralRenderingDebugEnabled() const#
Returns the current value indicating if debug visualization for peripheral rendering is enabled. This parameter is stored in the following configuration file: *.boot .
Return value
true if debug visualization for peripheral rendering is enabled; otherwise false. The default value is true.void setPeripheralRenderingBorderWidth ( float width = 0.2f ) #
Console: vr_peripheral_rendering_border_width
Sets a new width of the transition border between foveal (focus) and context rendering zones. A value of 1.0 means the entire viewport has a wide, smooth transition. A very small value (close to epsilon) means the transition will be extremely narrow and almost invisible. This parameter is stored in the following configuration file: *.boot .
Arguments
- float width - The width of the transition border between foveal (focus) and context rendering zones. A value of 1.0 means the entire viewport has a wide, smooth transition. A very small value (close to epsilon) means the transition will be extremely narrow and almost invisible.
Range of values: [eps, 1.0f]. The default value is : 0.2f.
float getPeripheralRenderingBorderWidth() const#
Console: vr_peripheral_rendering_border_width
Returns the current width of the transition border between foveal (focus) and context rendering zones. A value of 1.0 means the entire viewport has a wide, smooth transition. A very small value (close to epsilon) means the transition will be extremely narrow and almost invisible. This parameter is stored in the following configuration file: *.boot .
Return value
Current width of the transition border between foveal (focus) and context rendering zones. A value of 1.0 means the entire viewport has a wide, smooth transition. A very small value (close to epsilon) means the transition will be extremely narrow and almost invisible.Range of values: [eps, 1.0f]. The default value is : 0.2f.
void setPeripheralRenderingFOVScale ( ) #
Console: vr_peripheral_rendering_fov_scale
Sets a new scale factor applied to the field of view used for focus viewports. This parameter is stored in the following configuration file: *.boot .
Arguments
- fovscale - The scale factor applied to the field of view used for focus viewports.
[-1; 1] - available range.
(0.3f, 0.3f) - default value.
getPeripheralRenderingFOVScale() const#
Console: vr_peripheral_rendering_fov_scale
Returns the current scale factor applied to the field of view used for focus viewports. This parameter is stored in the following configuration file: *.boot .
Return value
Current scale factor applied to the field of view used for focus viewports.[-1; 1] - available range.
(0.3f, 0.3f) - default value.
void setPeripheralRenderingFocusScale ( ) #
Console: vr_peripheral_rendering_focus_scale
Sets a new scale factor controlling the size of the foveal (focus) area. This parameter is stored in the following configuration file: *.boot .
Arguments
- scale - The scale factor controlling the size of the foveal (focus) area.
[-1; 1] - available range.
(0.5f, 0.2f) - default value.
getPeripheralRenderingFocusScale() const#
Console: vr_peripheral_rendering_focus_scale
Returns the current scale factor controlling the size of the foveal (focus) area. This parameter is stored in the following configuration file: *.boot .
Return value
Current scale factor controlling the size of the foveal (focus) area.[-1; 1] - available range.
(0.5f, 0.2f) - default value.
void setPeripheralRenderingFocusDeadzone ( float deadzone = 0.15f ) #
Sets a new angular deadzone between the focus and context viewport transition. This parameter is stored in the following configuration file: *.boot .
Arguments
- float deadzone - The angular deadzone between the focus and context viewport transition.
Range of values: [0.0f, 1.0f]. The default value is : 0.15f.
float getPeripheralRenderingFocusDeadzone() const#
Returns the current angular deadzone between the focus and context viewport transition. This parameter is stored in the following configuration file: *.boot .
Return value
Current angular deadzone between the focus and context viewport transition.Range of values: [0.0f, 1.0f]. The default value is : 0.15f.
void setMirrorMode ( int mode = 3 ) #
Console: vr_mirror_mode
Sets a new mirror mode that defines how the mirrored image (i.e. VR image) will be displayed in the target window. This parameter is stored in the following configuration file: *.boot .
Arguments
- int mode - The mirror mode that defines how the mirrored image (i.e. VR image) will be displayed in the target window. One of the following values:
- 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)
int getMirrorMode() const#
Console: vr_mirror_mode
Returns the current mirror mode that defines how the mirrored image (i.e. VR image) will be displayed in the target window. This parameter is stored in the following configuration file: *.boot .
Return value
Current mirror mode that defines how the mirrored image (i.e. VR image) will be displayed in the target window. One of the following values:- 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)
void setWindowMode ( int mode = 1 ) #
Console: vr_window_mode
Sets a new window mode that defines which window will display the mirrored image (i.e. VR image). This parameter is stored in the following configuration file: *.boot .
Arguments
- int mode - The window mode that defines which window will display the mirrored image (i.e. VR image). One of the following values:
- 0 - mirroring is disabled.
- 1 - main window displays the mirrored image. (by default)
int getWindowMode() const#
Console: vr_window_mode
Returns the current window mode that defines which window will display the mirrored image (i.e. VR image). This parameter is stored in the following configuration file: *.boot .
Return value
Current window mode that defines which window will display the mirrored image (i.e. VR image). One of the following values:- 0 - mirroring is disabled.
- 1 - main window displays the mirrored image. (by default)
void setTrackingSpace ( int space = 1 ) #
Console: vr_tracking_space
Sets a new zero pose of the tracking origin. This parameter is stored in the following configuration file: *.boot .
Arguments
- int space - The zero pose of the tracking origin. One of the following values:
- 0 - seated.
- 1 - standing. (by default)
- 2 - raw (uncalibrated).
int getTrackingSpace() const#
Console: vr_tracking_space
Returns the current zero pose of the tracking origin. This parameter is stored in the following configuration file: *.boot .
Return value
Current zero pose of the tracking origin. One of the following values:- 0 - seated.
- 1 - standing. (by default)
- 2 - raw (uncalibrated).
void setMotionPrediction ( int prediction = 0 ) #
Console: vr_motion_prediction
Sets a new 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. This parameter is stored in the following configuration file: *.boot .
Arguments
- int prediction - The motion prediction The default value is false.
int isMotionPrediction() const#
Console: vr_motion_prediction
Returns the current 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. This parameter is stored in the following configuration file: *.boot .
Return value
Current motion prediction The default value is false.void setMotionPredictionVelocityPrecision ( float precision = 32.0f ) #
Sets a new factor of velocity scale before packing a floating point value into a 2x8 bit unsigned integer (uint).
*.boot .
Notice
This parameter is stored in the following configuration file: This feature is available for the Varjo devices only.
Arguments
- float precision - The factor of velocity scale before packing a floating point value into a 2x8 bit unsigned integer (uint).
Range of values: [eps, inf]. The default value is : 32.0f.
float getMotionPredictionVelocityPrecision() const#
Returns the current factor of velocity scale before packing a floating point value into a 2x8 bit unsigned integer (uint).
*.boot .
Notice
This parameter is stored in the following configuration file: This feature is available for the Varjo devices only.
Return value
Current factor of velocity scale before packing a floating point value into a 2x8 bit unsigned integer (uint).Range of values: [eps, inf]. The default value is : 32.0f.
void setMotionPredictionVelocityTimeDelta ( float delta = 1.0f / 60.0f ) #
Sets a new factor for optimizing between fast and slow-moving objects. A smaller number works better for fast-moving objects, and vice versa.
*.boot .
Notice
This parameter is stored in the following configuration file: This feature is available for the Varjo devices only.
Arguments
- float delta - The factor for optimizing between fast and slow-moving objects. A smaller number works better for fast-moving objects, and vice versa.
Range of values: [eps, inf]. The default value is : 1.0f / 60.0f.
float getMotionPredictionVelocityTimeDelta() const#
Returns the current factor for optimizing between fast and slow-moving objects. A smaller number works better for fast-moving objects, and vice versa.
*.boot .
Notice
This parameter is stored in the following configuration file: This feature is available for the Varjo devices only.
Return value
Current factor for optimizing between fast and slow-moving objects. A smaller number works better for fast-moving objects, and vice versa.Range of values: [eps, inf]. The default value is : 1.0f / 60.0f.
void setFoveatedRenderingEnabled ( int enabled = 1 ) #
Console: vr_foveated_rendering_enabled
Sets a new 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.
*.boot .
Notice
This parameter is stored in the following configuration file: This feature is available for the Varjo devices only.
Arguments
- int enabled - The foveated rendering The default value is true.
int isFoveatedRenderingEnabled() const#
Console: vr_foveated_rendering_enabled
Returns the current 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.
*.boot .
Notice
This parameter is stored in the following configuration file: This feature is available for the Varjo devices only.
Return value
Current foveated rendering The default value is true.const char * getApiName() const#
Returns the current name of the VR API: Null, OpenVR, OpenXR, or Varjo.
Return value
Current name of the VR API.int getApiType() const#
Returns the current type of the VR API.
Return value
Current type of the VR API.float getHMDRefreshRate() const#
Returns the current refresh rate of the head-mounted display.
Return value
Current refresh rate of the HMD.Vec3 getHandTrackingOffset() const#
Returns the current hand tracking offset (for the Ultraleap device only).
Return value
Current hand tracking offset.bool isHandTrackingOffsetSupported() const#
Returns the current value indicating if the hand tracking offset is supported.
Return value
true if the hand tracking offset is supported; otherwise false.int isPeripheralRenderingModeUsed() const#
Returns the current value indicating if the peripheral rendering is used.
Return value
Current the peripheral rendering is usedint isHMDConnected() const#
Returns the current value indicating if the head-mounted display is connected.
Return value
Current the HMD is connectedint isUsingFoveatedRendering() const#
Returns the current value indicating if the foveated rendering is used.
Return value
Current the foveated rendering is usedViewport getViewport() const#
Returns the current viewport. It can be useful when implementing extra VR logic.
Return value
Current viewport.getPlayerIModelview() const#
Returns the current inverse model-view matrix of the camera that renders VR.
Return value
Current inverse model-view matrix.getPlayerModelview() const#
Returns the current model-view matrix of the camera that renders VR.
Return value
Current model-view matrix.getPlayerWorldTransform() const#
Returns the current world transformation of the camera that renders VR.
Return value
Current world transformation matrix.static Event<bool> getEventRenderModelsVisibility() const#
The event handler signature is as follows: myhandler()Usage Example
Source code
Return value
Event reference.static getEventAudioSettingsChanged() const#
The event handler signature is as follows: myhandler()Usage Example
Source code
Return value
Event reference.static Event<int> getEventDeviceRenderModelChanged() const#
The event handler signature is as follows: myhandler()Usage Example
Source code
Return value
Event reference.bool isSteamVRDashboardActive() const#
Returns the current value indicating if the SteamVR controllers are rendered. When you access the SteamVR menu during the application runtime, the SteamVR controllers start to be rendered along with the application controllers. You can use this function to check the state of the SteamVR controllers and disable the application controllers to avoid performance drops caused by the simultaneous rendering of both controllers.
Return value
true if the SteamVR controllers are rendered is enabled; otherwise false.getInputRuntimeType() const#
Returns the current type of the VR input runtime.
Return value
Current type of the VR input runtime.const char * getInputRuntimeName() const#
Returns the current name of the VR input runtime.
Return value
Current name of the VR input runtime.const char * getInputRuntimeVersion() const#
Returns the current version of the VR input runtime.
Return value
Current version of the VR input runtime.void setDebugMode ( ) #
Sets a new debug mode for VR. If the debug mode is disabled, displaying of GAPI errors in VR runtime is also disabled.
Arguments
- mode - The debug mode for VR.
getDebugMode() const#
Returns the current debug mode for VR. If the debug mode is disabled, displaying of GAPI errors in VR runtime is also disabled.
Return value
Current debug mode for VR.void setRenderWhileHMDIdle ( bool hmdidle ) #
Sets a new value indicating if rendering is enabled while HMD is not worn.
Arguments
- bool hmdidle - Set true to enable rendering while HMD is not worn; false - to disable it.
bool isRenderWhileHMDIdle() const#
Returns the current value indicating if rendering is enabled while HMD is not worn.
Return value
true if rendering while HMD is not worn is enabled; otherwise false.float getEyeNativeFOV() const#
Returns the current device-native vertical field of view in radians (measured from the left eye).
Return value
Current device-native vertical field of view in radians (measured from the left eye).void setEyeOverrideFOV ( float fov ) #
Sets a new vertical field of view override value (in degrees).
Arguments
- float fov - The vertical field of view override value (in degrees). Range of values: [0.00001f; 179.0f]
float getEyeOverrideFOV() const#
Returns the current vertical field of view override value (in degrees).
Return value
Current vertical field of view override value (in degrees). Range of values: [0.00001f; 179.0f]bool isEyeOverriddenFOV() const#
Returns the current value indicating if the native vertical field of view value has been overridden (i.e., differs from the native field of view).
Return value
true if the native vertical field of view value has been overridden (i.e., differs from the native field of view); otherwise false.ivec2 engine.vr.getHMDResolution ( int viewport_type = Enum.VR.VIEWPORT_TYPE.CONTEXT ) #
Returns the current resolution of the head-mounted display. For HMDs having context (peripheral) and focus displays, you should specify the viewport type.Arguments
- int viewport_type - Type of the viewport (for HMDs having context (peripheral) and focus displays).
Return value
HMD resolution.int engine.vr.hasFeatureMixedReality ( ) #
Returns a value indicating if the mixed reality mode is available. Mixed reality enables you to combine real-world view from front-facing cameras mounted on the headset with the VR image rendered. This feature is available for the Varjo devices only.Notice
If VR is not initialized, the function will return false.
Return value
true if the feature is available; otherwise, false.int engine.vr.hasFeatureEyeTracking ( ) #
Returns a value indicating if eye tracking is available. This feature is available for the Varjo devices only.Notice
If VR is not initialized, the function will return false.
Return value
true if the feature is available; otherwise, false.int engine.vr.hasFeatureHandTracking ( ) #
Returns a value indicating if hand tracking is available. This feature is available for the Varjo devices only.Notice
If VR is not initialized, the function will return false.
Return value
true if the feature is available; otherwise, false.int engine.vr.hasFeatureTrackingSpaceRaw ( ) #
Returns a value indicating if poses can be provided in the coordinate system defined by the tracker driver.Notice
If VR is not initialized, the function will return false.
Return value
true if the feature is available; otherwise, false.int engine.vr.hasFeatureMotionPrediction ( ) #
Returns a value indicating if motion prediction is available. This feature is available for the Varjo devices only. It allows the engine to submit the velocity from the GBuffer to the Varjo Composer.Notice
If VR is not initialized, the function will return false.
Return value
true if the feature is available; otherwise, false.int engine.vr.hasFeatureFoveatedRendering ( ) #
Returns a value indicating if foveated rendering is available. This feature is available for the Varjo devices only. Foveated rendering enhances performance by using the eye tracking functionality in Varjo headsets: it decreases the image quality in the peripheral areas where the user is not looking. Foveation allows applications to render fewer pixels and achieve a better VR experience.Notice
If VR is not initialized, the function will return false.
Return value
true if the feature is available; otherwise, false.int engine.vr.hasFeatureReportProximitySensor ( ) #
Returns a value indicating if proximity sensor reporting is available.Notice
If VR is not initialized, the function will return false.
Return value
true if the feature is available; otherwise, false.int engine.vr.hasFeatureSupportForTreadmill ( ) #
Returns a value indicating if the user treadmill support is available.Notice
If VR is not initialized, the function will return false.
Return value
true if the feature is available; otherwise, false.int engine.vr.hasFeatureSupportForBaseStations ( ) #
Returns a value indicating if the base stations support is available.Notice
If VR is not initialized, the function will return false.
Return value
true if the feature is available; otherwise, false.int engine.vr.hasFeatureSupportForTrackers ( ) #
Returns a value indicating if support for trackers is available.Notice
If VR is not initialized, the function will return false.
Return value
true if the feature is available; otherwise, false.int engine.vr.hasFeatureSupportForRenderModelComponents ( ) #
Returns a value indicating if support for render model components is available.Notice
If VR is not initialized, the function will return false.
Return value
true if the feature is available; otherwise, false.static int engine.vr.resetZeroPose ( ) #
Sets the zero pose to the current tracker position.Return value
true if the pose is reset successfully; otherwise, false.int engine.vr.hasFeatureSupportForRenderModel ( ) #
Returns a value indicating if VR API can provide Render Models for the controllers.Notice
If VR is not initialized, the function will return false.
Return value
true if the feature is available; otherwise, false.int engine.vr.hasFeatureFadeToColor ( ) #
Returns a value indicating if the FadeToColor feature is available.Notice
If VR is not initialized, the function will return false.
Return value
true if the feature is available; otherwise, false.int engine.vr.hasFeatureFadeGrid ( ) #
Returns the value indicating if the FadeGrid feature is available.Notice
If VR is not initialized, the function will return false.
Return value
true if the feature is available; otherwise, false.int engine.vr.hasFeatureGetAudioDevice ( ) #
Returns the value indicating if VR API can return Audio Device name (usually Oculus only).Notice
If VR is not initialized, the function will return false.
Return value
true if the feature is available; otherwise, false.void engine.vr.fadeToColor ( float seconds, vec4 color, int background ) #
Fades the engine render to the specified color over time.Arguments
- float seconds - Fade period, in seconds.
- vec4 color - Target color.
- int background
void engine.vr.fadeGrid ( float seconds, int fade_in ) #
Fades the engine render to/from the grid over the specified time.Arguments
- float seconds - Fade period, in seconds.
- int fade_in - true fades render to grid; false fades grid to render.
void engine.vr.clearScriptableMaterials ( int eye ) #
Removes all scriptable materials assigned to the target eye.Arguments
- int eye - Target eye.
int engine.vr.getNumScriptableMaterials ( int eye ) #
Returns the number of scriptable materials currently assigned to the specified eye.Arguments
- int eye - Target eye.
Return value
Number of scriptable materials currently assigned to the specified eye.Material engine.vr.getScriptableMaterial ( int eye, int num ) #
Returns the scriptable material assigned to the target eye by the number. The material's number determines the order in which the expressions assigned to it are executed.Arguments
- int eye - Target eye.
- int num - Scriptable material number in the range from 0 to the total number of scriptable materials.
Return value
Scriptable material assigned to the target eye.void engine.vr.setScriptableMaterial ( int eye, int num, Material material ) #
Replaces the specified scriptable material with a new scriptable material by its number for the target eye. The material's number determines the order in which the expressions assigned to it are executed.Notice
Scriptable materials applied globally have their expressions executed before the ones that are applied per-eye.
Arguments
- int eye - Target eye.
- int num - Scriptable material number in the range from 0 to the total number of scriptable materials.
- Material material - New scriptable material to replace the one with the specified number.
void engine.vr.insertScriptableMaterial ( int eye, int num, Material material ) #
Inserts a new scriptable material at the specified position for the target eye. The material's number determines the order in which the expressions assigned to it are executed. To apply a scriptable material globally, use the insertScriptableMaterial() method of the Render class.Notice
Scriptable materials applied globally have their expressions executed before the ones that are applied per-eye.
Arguments
- int eye - Target eye.
- int num - Position at which the new scriptable material is to be inserted.
- Material material - Scriptable material to be inserted.
int engine.vr.findScriptableMaterial ( int eye, Material material ) #
Returns the number of the specified scriptable material for the target eye. The material's number determines the order in which the expressions assigned to it are executed.Notice
Scriptable materials applied globally have their expressions executed before the ones that are applied per-eye.
Arguments
- int eye - Target eye.
- Material material - Scriptable material for which the number is to be found.
Return value
The number of the specified scriptable material for the target eye.void engine.vr.addScriptableMaterial ( int eye, Material material ) #
Adds the specified scriptable material to the target eye's material list. The material's number determines the order in which the expressions assigned to it are executed. To apply a scriptable material globally, use the addScriptableMaterial() method of the Render class.Notice
Scriptable materials applied globally have their expressions executed before the ones that are applied per-eye.
Arguments
- int eye - Target eye.
- Material material - Scriptable material to add.
void engine.vr.removeScriptableMaterial ( int eye, int num ) #
Removes the scriptable material with the specified number from the target eye's material list.Arguments
- int eye - Target eye.
- int num - Scriptable material number in the range from 0 to the total number of scriptable materials.
void engine.vr.swapScriptableMaterials ( int eye, int num_0, int num_1 ) #
Swaps two scriptable materials with the specified numbers in the target eye's material list. The material's number determines the order in which the expressions assigned to it are executed.Arguments
- int eye - Target eye.
- int num_0 - Number of the first scriptable material in the range from 0 to the total number of scriptable materials.
- int num_1 - Number of the second scriptable material in the range from 0 to the total number of scriptable materials.
void engine.vr.setScriptableMaterialEnabled ( int eye, int num, int enabled ) #
Enables or disables the scriptable material with the specified number for the target eye. When a material is disabled (inactive), the scripts attached to it are not executed.Arguments
- int eye - Target eye.
- int num - Scriptable material number in the range from 0 to the total number of scriptable materials.
- int enabled - true to enable the scriptable material with the specified number, false to disable it.
int engine.vr.getScriptableMaterialEnabled ( int eye, int num ) #
Returns a value indicating if the scriptable material with the specified number is enabled (active) for the target eye. When a material is disabled (inactive), the scripts attached to it are not executed.Arguments
- int eye - Target eye.
- int num - Scriptable material number in the range from 0 to the total number of scriptable materials.
Return value
true if the scriptable material with the specified number is enabled; otherwise, false.void engine.vr.setEyeOffset ( int eye, mat4 offset ) #
Sets a custom transformation matrix to be applied to the target eye.Arguments
- int eye - Target eye.
- mat4 offset - Transformation matrix to be applied to the target eye.
mat4 engine.vr.getEyeOffset ( int eye ) #
Returns the current transformation matrix applied to the target eye.Arguments
- int eye - Target eye.
Return value
Transformation matrix currently applied to the target eye.void engine.vr.resetEyeOffset ( int eye ) #
Resets the transformation offset of the target eye to the identity matrix.Arguments
- int eye - Target eye.
void engine.vr.resetEyeOffset ( ) #
Resets the transformation offsets for both eyes to the identity matrix.void engine.vr.resetEyeOverrideFOV ( ) #
Resets the vertical field of view override to the native value.The information on this page is valid for UNIGINE 2.20 SDK.
Last update:
2025-07-10
Help improve this article
Was this article helpful?
(or select a word/phrase and press Ctrl+Enter)