Inheritance #

MobileVRInterface #

is_refcounted, is_instantiable, core, not_builtin_classes

Generic mobile VR implementation.

This is a generic mobile VR implementation where you need to provide details about the phone and HMD used. It does not rely on any existing framework. This is the most basic interface we have. For the best effect, you need a mobile phone with a gyroscope and accelerometer.

Note that even though there is no positional tracking, the camera will assume the headset is at a height of 1.85 meters. You can change this by setting eye_height.

You can initialize this interface as follows:

var interface = XRServer.find_interface("Native mobile")
if interface and interface.initialize():
    get_viewport().use_xr = true

Note: For Android, ProjectSettings.input_devices/sensors/enable_accelerometer, ProjectSettings.input_devices/sensors/enable_gravity, ProjectSettings.input_devices/sensors/enable_gyroscope and ProjectSettings.input_devices/sensors/enable_magnetometer must be enabled.

Members #

var display_to_lens: float = 4.0#

The distance between the display and the lenses inside of the device in centimeters.

var display_width: float = 14.5#

The width of the display in centimeters.

var eye_height: float = 1.85#

The height at which the camera is placed in relation to the ground (i.e. XROrigin3D node).

var iod: float = 6.0#

The interocular distance, also known as the interpupillary distance. The distance between the pupils of the left and right eye.

var k1: float = 0.215#

The k1 lens factor is one of the two constants that define the strength of the lens used and directly influences the lens distortion effect.

var k2: float = 0.215#

The k2 lens factor, see k1.

var offset_rect: Rect2 = Rect2(0, 0, 1, 1)#

Set the offset rect relative to the area being rendered. A length of 1 represents the whole rendering area on that axis.

var oversample: float = 1.5#

The oversample setting. Because of the lens distortion we have to render our buffers at a higher resolution then the screen can natively handle. A value between 1.5 and 2.0 often provides good results but at the cost of performance.

var vrs_min_radius: float = 20.0#

The minimum radius around the focal point where full quality is guaranteed if VRS is used as a percentage of screen size.

Note: Mobile and Forward+ renderers only. Requires Viewport.vrs_mode to be set to Viewport.VRS_XR.

var vrs_strength: float = 1.0#

The strength used to calculate the VRS density map. The greater this value, the more noticeable VRS is. This improves performance at the cost of quality.

Note: Mobile and Forward+ renderers only. Requires Viewport.vrs_mode to be set to Viewport.VRS_XR.

var xr_play_area_mode = XR_PLAY_AREA_3DOF#

Methods #

Annotations #

Constants #

Constructors #

Enums #

Operators #

Signals #

Theme Items #

Tutorials #