Description

This object provides access to the GearVR interface.

Other related reference items

Functions

clear_all_tracker_node_links ( )

Clears all tracker node links made using GearVR.link_node_to_tracker.

Parameters

This function does not accept any parameters.

Returns

This function does not return any values.

clear_layers ( )

Clears all layers

Parameters

This function does not accept any parameters.

Returns

This function does not return any values.

create_layer ( name, layer_rt )

Creates a monoscopic image that is displayed as a rectangle headlocked in front of the HMD.

Parameters

name :	string	The layer name.
layer_rt :	string	The layer render target name.

Returns

This function does not return any values.

This is useful for heads-up-displays, text information, object labels and so on.

enable ( enabled )

Enables or disables rendering to the GearVR device.

Parameters

enabled :

boolean

The enabled state flag.

Returns

This function does not return any values.

eye_info ( eye ) : table

Returns a table containing information on the specified eye.

Parameters

eye :

integer

The eye to query (stingray.GearVR.EYE_LEFT or stingray.GearVR.EYE_RIGHT)

Returns

table

Table populated with eye information.

hmd_info ( ) : table

Returns a table containing HMD information.

Parameters

This function does not accept any parameters.

Returns

table

Table populated with GearVR HMD information.

hmd_local_pose ( ) : stingray.Matrix4x4, stingray.Matrix4x4, stingray.Matrix4x4

Returns the head, left eye and right eye local poses of the HMD.

Parameters

This function does not accept any parameters.

Returns

stingray.Matrix4x4	Head local pose
stingray.Matrix4x4	Left eye local pose
stingray.Matrix4x4	Right eye local pose

hmd_world_pose ( ) : stingray.Matrix4x4, stingray.Matrix4x4, stingray.Matrix4x4

Returns the head, left eye and right eye world poses of the HMD.

Parameters

This function does not accept any parameters.

Returns

stingray.Matrix4x4	Head world pose
stingray.Matrix4x4	Left eye world pose
stingray.Matrix4x4	Right eye world pose

If not tracked, identity matrices are returned.

initialize ( ) : boolean

Initializes GearVR system.

Parameters

This function does not accept any parameters.

Returns

boolean

Returns true if GearVR was initialized properly, otherwise returns false.

link_node_to_tracker ( unit, node, type, index, world )

Links a Unit node to be automatically updated by the VR tracker.

Parameters

unit :	stingray.Unit	Unit to link to tracker
node :	integer	Scene graph node that is linked within the unit
type :	integer	Type of tracker link (GearVR.LINK_HMD)
index :	integer	Index of HMD (i.e. GearVR.EYE_LEFT or GearVR.EYE_RIGHT when using GearVR.LINK_HMD type)
world :	stingray.World	World containing the unit

Returns

This function does not return any values.

mobile_options ( ) : gearvr_mobile_options

Returns a table that contains the current mobile options.

Parameters

This function does not accept any parameters.

Returns

gearvr_mobile_options

A table that contains the current values of the mobile options. For details on its fields and types, see gearvr_mobile_options.

Other related reference items

profile ( ) : table

Returns a table containing the current active profile data.

Parameters

This function does not accept any parameters.

Returns

table

Table populated with current profile data set using GearVR Configuration Utility.

More specifically, it returns the player height, eye height, interpupillary and neck to eye distances in meters.

recenter ( )

Re-centers the sensor position and orientation.

Parameters

This function does not accept any parameters.

Returns

This function does not return any values.

remove_layer ( name )

Removes the specified layer.

Parameters

name :

string

The layer name.

Returns

This function does not return any values.

setup_hmd ( left_eye_rt, right_eye_rt, left_eye_fov_left, left_eye_fov_right, left_eye_fov_down, left_eye_fov_up, right_eye_fov_left, right_eye_fov_right, right_eye_fov_down, right_eye_fov_up, flags )

Setup GearVR based on specified parameters.

Parameters

left_eye_rt :	string	The left eye render target name.
right_eye_rt :	string	The right eye render target name.
left_eye_fov_left :	number	The left eye left frustum angle.
left_eye_fov_right :	number	The left eye right frustum angle.
left_eye_fov_down :	number	The left eye down frustum angle.
left_eye_fov_up :	number	The left eye up frustum angle.
right_eye_fov_left :	number	The right eye left frustum angle.
right_eye_fov_right :	number	The right eye right frustum angle.
right_eye_fov_down :	number	The right eye down frustum angle.
right_eye_fov_up :	number	The right eye up frustum angle.
flags :	integer?	Optional; Setup flags. The ? notation indicates that this type is optional: there may be zero or one instances of it.

Returns

This function does not return any values.

set_high_quality_layer ( name, hq_enabled )

Enable or disable 4x anisotropic sampling in the compositor for the specified layer.

Parameters

name :	string	The name of the layer to set to the high quality render path.
hq_enabled :	boolean	Whether or not this layer should use the high quality render path.

Returns

This function does not return any values.

set_layer_dimensions ( name, width, height )

Sets the dimensions of the layer quad.

Parameters

name :	string	The name of the layer to update.
width :	number	The layer quad width in meters
height :	number	The layer quad height in meters

Returns

This function does not return any values.

By default layers are rendered on a quad that is 1 meter across.

set_layer_pose ( name, pose, headlocked )

Sets the layer pose.

Parameters

name :	string	The name of the layer to update.
pose :	stingray.Matrix4x4	The layer center pose.
headlocked :	boolean	Whether the layer pose is relative to the HMD (headlocked) or relative to the tracking origin.

Returns

This function does not return any values.

By default, the pose is headlocked 0.5m infront of the HMD.

set_layer_visibility ( name, visible )

Specify if a layer should be visible or hidden.

Parameters

name :	string	The name of the layer.
visible :	boolean	Whether or not this layer is visible.

Returns

This function does not return any values.

set_mobile_options ( options )

Sets the mobile options for the GearVR plugin that you specify in the options table.

Parameters

options :

gearvr_mobile_options?

A table that contains the options and values you want to set. For details on its fields and types, see gearvr_mobile_options.

The ? notation indicates that this type is optional: there may be zero or one instances of it.

Returns

This function does not return any values.

Call this function before [stingray.GearVR.setup()].

Other related reference items

set_tracking_space_pose ( pose )

Sets provided pose as the default tracking space pose

Parameters

pose :

stingray.Matrix4x4

Tracking space pose

Returns

This function does not return any values.

shutdown ( )

Shuts down GearVR system.

Parameters

This function does not accept any parameters.

Returns

This function does not return any values.

unlink_node_from_tracker ( unit, node )

Unlinks a Unit node that is being automatically updated by the VR tracker.

Parameters

unit :	stingray.Unit	Unit to unlink from the VR tracker
node :	integer	Scene graph node within the unit that is to be unlinked

Returns

This function does not return any values.

valid_session ( ) : boolean

Parameters

This function does not accept any parameters.

Returns

boolean

true if the device session is valid. On desktop this happens after GearVR.initialize, on mobile this happens after GearVR.enable

Extra latency modes

These modes are used as frame parameters for the GearVR Mobile SDK.

You can set them in the extra_latency_mode field of the table that you pass to set_mobile_options(). For example:

local settings = { extra_latency_mode = stingray.GearVR.EXTRA_LATENCY_OFF }
stingray.GearVR.set_mobile_options(settings)

EXTRA_LATENCY_DYNAMIC : integer

VRAPI_EXTRA_LATENCY_MODE_DYNAMIC

EXTRA_LATENCY_OFF : integer

VRAPI_EXTRA_LATENCY_MODE_OFF

Other related reference items

Extra latency modes

EXTRA_LATENCY_ON : integer

VRAPI_EXTRA_LATENCY_MODE_ON

GearVR - stingray.GearVR namespace reference - Stingray Lua API Reference

Description

Functions

clear_all_tracker_node_links ( )

clear_layers ( )

create_layer ( name, layer_rt )

enable ( enabled )

eye_info ( eye ) : table

hmd_info ( ) : table

hmd_local_pose ( ) : stingray.Matrix4x4, stingray.Matrix4x4, stingray.Matrix4x4

hmd_world_pose ( ) : stingray.Matrix4x4, stingray.Matrix4x4, stingray.Matrix4x4

initialize ( ) : boolean

link_node_to_tracker ( unit, node, type, index, world )

mobile_options ( ) : gearvr_mobile_options

profile ( ) : table

recenter ( )

remove_layer ( name )

setup_hmd ( left_eye_rt, right_eye_rt, left_eye_fov_left, left_eye_fov_right, left_eye_fov_down, left_eye_fov_up, right_eye_fov_left, right_eye_fov_right, right_eye_fov_down, right_eye_fov_up, flags )

set_high_quality_layer ( name, hq_enabled )

set_layer_dimensions ( name, width, height )

set_layer_pose ( name, pose, headlocked )

set_layer_visibility ( name, visible )

set_mobile_options ( options )

set_tracking_space_pose ( pose )

shutdown ( )

unlink_node_from_tracker ( unit, node )

valid_session ( ) : boolean

Extra latency modes

EXTRA_LATENCY_DYNAMIC : integer

EXTRA_LATENCY_OFF : integer

EXTRA_LATENCY_ON : integer