XRInterface

Inherited By: MobileVRInterface, OpenXRInterface, WebXRInterface, XRInterfaceExtension

There is currently no description for this class. Please help us by contributing one!

Properties

bool	ar_is_anchor_detection_enabled	`false`
EnvironmentBlendMode	environment_blend_mode	`0`
bool	interface_is_primary	`false`
PlayAreaMode	xr_play_area_mode	`0`

Methods

int	get_camera_feed_id ( )
int	get_capabilities ( ) const
StringName	get_name ( ) const
PackedVector3Array	get_play_area ( ) const
Projection	get_projection_for_view ( int view, float aspect, float near, float far )
Vector2	get_render_target_size ( )
Array	get_supported_environment_blend_modes ( )
Dictionary	get_system_info ( )
TrackingStatus	get_tracking_status ( ) const
Transform3D	get_transform_for_view ( int view, Transform3D cam_transform )
int	get_view_count ( )
bool	initialize ( )
bool	is_initialized ( ) const
bool	is_passthrough_enabled ( )
bool	is_passthrough_supported ( )
bool	set_environment_blend_mode ( EnvironmentBlendMode mode )
bool	set_play_area_mode ( PlayAreaMode mode )
bool	start_passthrough ( )
void	stop_passthrough ( )
bool	supports_play_area_mode ( PlayAreaMode mode )
void	trigger_haptic_pulse ( String action_name, StringName tracker_name, float frequency, float amplitude, float duration_sec, float delay_sec )
void	uninitialize ( )

Signals

play_area_changed ( int mode )

There is currently no description for this signal. Please help us by contributing one!

Enumerations

enum Capabilities:

Capabilities XR_NONE = 0

There is currently no description for this enum. Please help us by contributing one!

Capabilities XR_MONO = 1

There is currently no description for this enum. Please help us by contributing one!

Capabilities XR_STEREO = 2

There is currently no description for this enum. Please help us by contributing one!

Capabilities XR_QUAD = 4

There is currently no description for this enum. Please help us by contributing one!

Capabilities XR_VR = 8

There is currently no description for this enum. Please help us by contributing one!

Capabilities XR_AR = 16

There is currently no description for this enum. Please help us by contributing one!

Capabilities XR_EXTERNAL = 32

There is currently no description for this enum. Please help us by contributing one!

enum TrackingStatus:

TrackingStatus XR_NORMAL_TRACKING = 0

There is currently no description for this enum. Please help us by contributing one!

TrackingStatus XR_EXCESSIVE_MOTION = 1

There is currently no description for this enum. Please help us by contributing one!

TrackingStatus XR_INSUFFICIENT_FEATURES = 2

There is currently no description for this enum. Please help us by contributing one!

TrackingStatus XR_UNKNOWN_TRACKING = 3

There is currently no description for this enum. Please help us by contributing one!

TrackingStatus XR_NOT_TRACKING = 4

There is currently no description for this enum. Please help us by contributing one!

enum PlayAreaMode:

PlayAreaMode XR_PLAY_AREA_UNKNOWN = 0

There is currently no description for this enum. Please help us by contributing one!

PlayAreaMode XR_PLAY_AREA_3DOF = 1

There is currently no description for this enum. Please help us by contributing one!

PlayAreaMode XR_PLAY_AREA_SITTING = 2

There is currently no description for this enum. Please help us by contributing one!

PlayAreaMode XR_PLAY_AREA_ROOMSCALE = 3

There is currently no description for this enum. Please help us by contributing one!

PlayAreaMode XR_PLAY_AREA_STAGE = 4

There is currently no description for this enum. Please help us by contributing one!

enum EnvironmentBlendMode:

EnvironmentBlendMode XR_ENV_BLEND_MODE_OPAQUE = 0

There is currently no description for this enum. Please help us by contributing one!

EnvironmentBlendMode XR_ENV_BLEND_MODE_ADDITIVE = 1

There is currently no description for this enum. Please help us by contributing one!

EnvironmentBlendMode XR_ENV_BLEND_MODE_ALPHA_BLEND = 2

There is currently no description for this enum. Please help us by contributing one!

Property Descriptions

bool ar_is_anchor_detection_enabled = false

void set_anchor_detection_is_enabled ( bool value )
bool get_anchor_detection_is_enabled ( )

There is currently no description for this property. Please help us by contributing one!

EnvironmentBlendMode environment_blend_mode = 0

bool set_environment_blend_mode ( EnvironmentBlendMode mode )
EnvironmentBlendMode get_environment_blend_mode ( )

There is currently no description for this property. Please help us by contributing one!

bool interface_is_primary = false

void set_primary ( bool value )
bool is_primary ( )

There is currently no description for this property. Please help us by contributing one!

PlayAreaMode xr_play_area_mode = 0

bool set_play_area_mode ( PlayAreaMode mode )
PlayAreaMode get_play_area_mode ( )

There is currently no description for this property. Please help us by contributing one!