OpenXRInterface

gdext.classes.OpenXRInterface
See theOpenXRInterface companion object
abstract class OpenXRInterface extends XRInterface

Generated wrapper for Godot's OpenXRInterface, extends XRInterface.

Attributes

Companion
object
Graph
Supertypes
class XRInterface
class RefCounted
class Object
class Object
trait Matchable
class Any
Show all

Members list

Value members

Concrete methods

final def getDisplayRefreshRate(): Double

OpenXRInterface.get_display_refresh_rate

OpenXRInterface.get_display_refresh_rate

Attributes

final def getFoveationDynamic(): Boolean

OpenXRInterface.get_foveation_dynamic

OpenXRInterface.get_foveation_dynamic

Attributes

final def getFoveationLevel(): Long

OpenXRInterface.get_foveation_level

OpenXRInterface.get_foveation_level

Attributes

final def getHandJointAngularVelocity(hand: Long, joint: Long): Vector3

OpenXRInterface.get_hand_joint_angular_velocity

OpenXRInterface.get_hand_joint_angular_velocity

Attributes

final def getHandJointFlags(hand: Long, joint: Long): Long

OpenXRInterface.get_hand_joint_flags

OpenXRInterface.get_hand_joint_flags

Attributes

final def getHandJointLinearVelocity(hand: Long, joint: Long): Vector3

OpenXRInterface.get_hand_joint_linear_velocity

OpenXRInterface.get_hand_joint_linear_velocity

Attributes

final def getHandJointPosition(hand: Long, joint: Long): Vector3

OpenXRInterface.get_hand_joint_position

OpenXRInterface.get_hand_joint_position

Attributes

final def getHandJointRadius(hand: Long, joint: Long): Double

OpenXRInterface.get_hand_joint_radius

OpenXRInterface.get_hand_joint_radius

Attributes

final def getHandJointRotation(hand: Long, joint: Long): Quaternion

OpenXRInterface.get_hand_joint_rotation

OpenXRInterface.get_hand_joint_rotation

Attributes

final def getHandTrackingSource(hand: Long): Long

OpenXRInterface.get_hand_tracking_source

OpenXRInterface.get_hand_tracking_source

Attributes

final def getMotionRange(hand: Long): Long

OpenXRInterface.get_motion_range

OpenXRInterface.get_motion_range

Attributes

final def getRenderTargetSizeMultiplier(): Double

OpenXRInterface.get_render_target_size_multiplier

OpenXRInterface.get_render_target_size_multiplier

Attributes

final def getSessionState(): Long

OpenXRInterface.get_session_state

OpenXRInterface.get_session_state

Attributes

final def getVrsMinRadius(): Double

OpenXRInterface.get_vrs_min_radius

OpenXRInterface.get_vrs_min_radius

Attributes

final def getVrsStrength(): Double

OpenXRInterface.get_vrs_strength

OpenXRInterface.get_vrs_strength

Attributes

override def godotClassName: String

The Godot class name for this instance. Engine wrappers override with the baked literal; user classes fall back to their Scala simple name (which is how registration names them).

The Godot class name for this instance. Engine wrappers override with the baked literal; user classes fall back to their Scala simple name (which is how registration names them).

Attributes

Definition Classes
final def isActionSetActive(name: String): Boolean

OpenXRInterface.is_action_set_active

OpenXRInterface.is_action_set_active

Attributes

final def isEyeGazeInteractionSupported(): Boolean

OpenXRInterface.is_eye_gaze_interaction_supported

OpenXRInterface.is_eye_gaze_interaction_supported

Attributes

final def isFoveationSupported(): Boolean

OpenXRInterface.is_foveation_supported

OpenXRInterface.is_foveation_supported

Attributes

final def isHandInteractionSupported(): Boolean

OpenXRInterface.is_hand_interaction_supported

OpenXRInterface.is_hand_interaction_supported

Attributes

final def isHandTrackingSupported(): Boolean

OpenXRInterface.is_hand_tracking_supported

OpenXRInterface.is_hand_tracking_supported

Attributes

final def setActionSetActive(name: String, active: Boolean): Unit

OpenXRInterface.set_action_set_active

OpenXRInterface.set_action_set_active

Attributes

final def setCpuLevel(level: Long): Unit

OpenXRInterface.set_cpu_level

OpenXRInterface.set_cpu_level

Attributes

final def setDisplayRefreshRate(refresh_rate: Double): Unit

OpenXRInterface.set_display_refresh_rate

OpenXRInterface.set_display_refresh_rate

Attributes

final def setFoveationDynamic(foveation_dynamic: Boolean): Unit

OpenXRInterface.set_foveation_dynamic

OpenXRInterface.set_foveation_dynamic

Attributes

final def setFoveationLevel(foveation_level: Long): Unit

OpenXRInterface.set_foveation_level

OpenXRInterface.set_foveation_level

Attributes

final def setGpuLevel(level: Long): Unit

OpenXRInterface.set_gpu_level

OpenXRInterface.set_gpu_level

Attributes

final def setMotionRange(hand: Long, motion_range: Long): Unit

OpenXRInterface.set_motion_range

OpenXRInterface.set_motion_range

Attributes

final def setRenderTargetSizeMultiplier(multiplier: Double): Unit

OpenXRInterface.set_render_target_size_multiplier

OpenXRInterface.set_render_target_size_multiplier

Attributes

final def setVrsMinRadius(radius: Double): Unit

OpenXRInterface.set_vrs_min_radius

OpenXRInterface.set_vrs_min_radius

Attributes

final def setVrsStrength(strength: Double): Unit

OpenXRInterface.set_vrs_strength

OpenXRInterface.set_vrs_strength

Attributes

Inherited methods

def _can_handle(obj: GodotObject): Boolean

EditorInspectorPlugin: can this plugin handle obj's inspector?

EditorInspectorPlugin: can this plugin handle obj's inspector?

Attributes

Inherited from:
GodotScriptClass
def _enter_tree(): Unit

EditorPlugin/Node: entered the (editor) tree.

EditorPlugin/Node: entered the (editor) tree.

Attributes

Inherited from:
GodotScriptClass
def _exit_tree(): Unit

EditorPlugin/Node: leaving the (editor) tree.

EditorPlugin/Node: leaving the (editor) tree.

Attributes

Inherited from:
GodotScriptClass
def _input(event: InputEvent): Unit

Called for every unhandled-or-not input event (Node._input).

Called for every unhandled-or-not input event (Node._input).

Attributes

Inherited from:
GodotScriptClass
def _parse_property(obj: GodotObject, varType: Long, name: String, hintType: Long, hintString: String, usage: Long, wide: Boolean): Boolean

EditorInspectorPlugin: inspect one property. Return true to take it over (after calling addPropertyEditor), false to let the default editor render.

EditorInspectorPlugin: inspect one property. Return true to take it over (after calling addPropertyEditor), false to let the default editor render.

Attributes

Inherited from:
GodotScriptClass
def _physics_process(delta: Double): Unit

Called every physics frame; delta is the fixed physics step.

Called every physics frame; delta is the fixed physics step.

Attributes

Inherited from:
GodotScriptClass
def _process(delta: Double): Unit

Called every rendered frame; delta is seconds since the last frame.

Called every rendered frame; delta is seconds since the last frame.

Attributes

Inherited from:
GodotScriptClass
def _ready(): Unit

Called when the node enters the scene tree and is ready.

Called when the node enters the scene tree and is ready.

Attributes

Inherited from:
GodotScriptClass
def _shortcut_input(event: InputEvent): Unit

Called for shortcut input before _unhandled_input (Node._shortcut_input).

Called for shortcut input before _unhandled_input (Node._shortcut_input).

Attributes

Inherited from:
GodotScriptClass
def _unhandled_input(event: InputEvent): Unit

Called for input not consumed by the UI (Node._unhandled_input).

Called for input not consumed by the UI (Node._unhandled_input).

Attributes

Inherited from:
GodotScriptClass
def _unhandled_key_input(event: InputEvent): Unit

Called for unhandled key input (Node._unhandled_key_input).

Called for unhandled key input (Node._unhandled_key_input).

Attributes

Inherited from:
GodotScriptClass
def _update_property(): Unit

EditorProperty: refresh the widget from the edited property's value.

EditorProperty: refresh the widget from the edited property's value.

Attributes

Inherited from:
GodotScriptClass
final def canTranslateMessages(): Boolean

Object.can_translate_messages

Object.can_translate_messages

Attributes

Inherited from:
Object
final def cancelFree(): Unit

Object.cancel_free

Object.cancel_free

Attributes

Inherited from:
Object
def cast[U <: GodotScriptClass](using meta: ClassMeta[U]): U

Cast to a (super- or sub-) class U. Returns null if the object is not actually a U. Uses object_cast_to with U's class tag — a real engine type check, not a Scala cast.

Cast to a (super- or sub-) class U. Returns null if the object is not actually a U. Uses object_cast_to with U's class tag — a real engine type check, not a Scala cast.

Attributes

Inherited from:
GodotScriptClass
def free(): Unit

Free a manually-managed object via object_destroy. No-op for reference-counted objects — use unref for those. The wrapper is dead afterwards: calling an engine method on it throws.

Free a manually-managed object via object_destroy. No-op for reference-counted objects — use unref for those. The wrapper is dead afterwards: calling an engine method on it throws.

Attributes

Inherited from:
GodotScriptClass
final def getAnchorDetectionIsEnabled(): Boolean

XRInterface.get_anchor_detection_is_enabled

XRInterface.get_anchor_detection_is_enabled

Attributes

Inherited from:
XRInterface
final def getCameraFeedId(): Long

XRInterface.get_camera_feed_id

XRInterface.get_camera_feed_id

Attributes

Inherited from:
XRInterface
final def getCapabilities(): Long

XRInterface.get_capabilities

XRInterface.get_capabilities

Attributes

Inherited from:
XRInterface
final def getEnvironmentBlendMode(): Long

XRInterface.get_environment_blend_mode

XRInterface.get_environment_blend_mode

Attributes

Inherited from:
XRInterface
final def getInstanceId(): Long

Object.get_instance_id

Object.get_instance_id

Attributes

Inherited from:
Object
final def getMethodArgumentCount(method: StringName): Long

Object.get_method_argument_count

Object.get_method_argument_count

Attributes

Inherited from:
Object
final def getName(): StringName

XRInterface.get_name

XRInterface.get_name

Attributes

Inherited from:
XRInterface
final def getPlayAreaMode(): Long

XRInterface.get_play_area_mode

XRInterface.get_play_area_mode

Attributes

Inherited from:
XRInterface
final def getProjectionForView(view: Long, aspect: Double, near: Double, far: Double): Projection

XRInterface.get_projection_for_view

XRInterface.get_projection_for_view

Attributes

Inherited from:
XRInterface
final def getReferenceCount(): Long

RefCounted.get_reference_count

RefCounted.get_reference_count

Attributes

Inherited from:
RefCounted

XRInterface.get_render_target_size

XRInterface.get_render_target_size

Attributes

Inherited from:
XRInterface
final def getTrackingStatus(): Long

XRInterface.get_tracking_status

XRInterface.get_tracking_status

Attributes

Inherited from:
XRInterface
final def getTransformForView(view: Long, cam_transform: Transform3D): Transform3D

XRInterface.get_transform_for_view

XRInterface.get_transform_for_view

Attributes

Inherited from:
XRInterface

Object.get_translation_domain

Object.get_translation_domain

Attributes

Inherited from:
Object
final def getViewCount(): Long

XRInterface.get_view_count

XRInterface.get_view_count

Attributes

Inherited from:
XRInterface
final def hasConnections(signal: StringName): Boolean

Object.has_connections

Object.has_connections

Attributes

Inherited from:
Object
final def hasMeta(name: StringName): Boolean

Object.has_meta

Object.has_meta

Attributes

Inherited from:
Object
final def hasMethod(method: StringName): Boolean

Object.has_method

Object.has_method

Attributes

Inherited from:
Object
final def hasSignal(signal: StringName): Boolean

Object.has_signal

Object.has_signal

Attributes

Inherited from:
Object
final def hasUserSignal(signal: StringName): Boolean

Object.has_user_signal

Object.has_user_signal

Attributes

Inherited from:
Object
final def hostObject: GodotObject

The engine-side object handle for this instance.

The engine-side object handle for this instance.

Attributes

Inherited from:
GodotScriptClass
final def initRef(): Boolean

RefCounted.init_ref

RefCounted.init_ref

Attributes

Inherited from:
RefCounted
final def initialize(): Boolean

XRInterface.initialize

XRInterface.initialize

Attributes

Inherited from:
XRInterface
final def instanceId: InstanceId

This object's stable Godot InstanceId (the null sentinel if unbound). Mirrors Object.get_instance_id, but typed — pass it to APIs that key off a node's identity.

This object's stable Godot InstanceId (the null sentinel if unbound). Mirrors Object.get_instance_id, but typed — pass it to APIs that key off a node's identity.

Attributes

Inherited from:
GodotScriptClass
final def isBlockingSignals(): Boolean

Object.is_blocking_signals

Object.is_blocking_signals

Attributes

Inherited from:
Object
final def isClass(`class`: String): Boolean

Object.is_class

Object.is_class

Attributes

Inherited from:
Object
final def isInitialized(): Boolean

XRInterface.is_initialized

XRInterface.is_initialized

Attributes

Inherited from:
XRInterface
final def isPassthroughEnabled(): Boolean

XRInterface.is_passthrough_enabled

XRInterface.is_passthrough_enabled

Attributes

Inherited from:
XRInterface
final def isPassthroughSupported(): Boolean

XRInterface.is_passthrough_supported

XRInterface.is_passthrough_supported

Attributes

Inherited from:
XRInterface
final def isPrimary(): Boolean

XRInterface.is_primary

XRInterface.is_primary

Attributes

Inherited from:
XRInterface
final def isQueuedForDeletion(): Boolean

Object.is_queued_for_deletion

Object.is_queued_for_deletion

Attributes

Inherited from:
Object
final def isRefCounted: Boolean

True if this object is reference-counted (RefCounted subtree, e.g. a Resource) vs manually-managed (Object/Node subtree). Drives the lifetime methods below.

True if this object is reference-counted (RefCounted subtree, e.g. a Resource) vs manually-managed (Object/Node subtree). Drives the lifetime methods below.

Attributes

Inherited from:
GodotScriptClass
def keep(): this.type

Keep a reference adopted inside Gd.scoped past the end of the block: the caller now owns it and releases it with unref. Returns this.

Keep a reference adopted inside Gd.scoped past the end of the block: the caller now owns it and releases it with unref. Returns this.

Attributes

Inherited from:
GodotScriptClass
final def notification(what: Long, reversed: Boolean): Unit

Object.notification

Object.notification

Attributes

Inherited from:
Object
final def notifyPropertyListChanged(): Unit

Object.notify_property_list_changed

Object.notify_property_list_changed

Attributes

Inherited from:
Object
final def propertyCanRevert(property: StringName): Boolean

Object.property_can_revert

Object.property_can_revert

Attributes

Inherited from:
Object
def refInc(): this.type

Take one more reference on a reference-counted object, owned by this wrapper until a matching unref. No-op for manually-managed objects (nodes). Returns this. (Named refInc rather than reference to avoid clashing with the generated RefCounted.reference(): Boolean method.)

Take one more reference on a reference-counted object, owned by this wrapper until a matching unref. No-op for manually-managed objects (nodes). Returns this. (Named refInc rather than reference to avoid clashing with the generated RefCounted.reference(): Boolean method.)

Attributes

Inherited from:
GodotScriptClass
final def reference(): Boolean

RefCounted.reference

RefCounted.reference

Attributes

Inherited from:
RefCounted
final def removeMeta(name: StringName): Unit

Object.remove_meta

Object.remove_meta

Attributes

Inherited from:
Object
final def removeUserSignal(signal: StringName): Unit

Object.remove_user_signal

Object.remove_user_signal

Attributes

Inherited from:
Object
final def setAnchorDetectionIsEnabled(enable: Boolean): Unit

XRInterface.set_anchor_detection_is_enabled

XRInterface.set_anchor_detection_is_enabled

Attributes

Inherited from:
XRInterface
final def setBlockSignals(enable: Boolean): Unit

Object.set_block_signals

Object.set_block_signals

Attributes

Inherited from:
Object
final def setEnvironmentBlendMode(mode: Long): Boolean

XRInterface.set_environment_blend_mode

XRInterface.set_environment_blend_mode

Attributes

Inherited from:
XRInterface
final def setMessageTranslation(enable: Boolean): Unit

Object.set_message_translation

Object.set_message_translation

Attributes

Inherited from:
Object
final def setPlayAreaMode(mode: Long): Boolean

XRInterface.set_play_area_mode

XRInterface.set_play_area_mode

Attributes

Inherited from:
XRInterface
final def setPrimary(primary: Boolean): Unit

XRInterface.set_primary

XRInterface.set_primary

Attributes

Inherited from:
XRInterface
final def setTranslationDomain(domain: StringName): Unit

Object.set_translation_domain

Object.set_translation_domain

Attributes

Inherited from:
Object
final def startPassthrough(): Boolean

XRInterface.start_passthrough

XRInterface.start_passthrough

Attributes

Inherited from:
XRInterface
final def stopPassthrough(): Unit

XRInterface.stop_passthrough

XRInterface.stop_passthrough

Attributes

Inherited from:
XRInterface
final def supportsPlayAreaMode(mode: Long): Boolean

XRInterface.supports_play_area_mode

XRInterface.supports_play_area_mode

Attributes

Inherited from:
XRInterface
final def tr(message: StringName, context: StringName): String

Object.tr

Object.tr

Attributes

Inherited from:
Object
final def trN(message: StringName, plural_message: StringName, n: Long, context: StringName): String

Object.tr_n

Object.tr_n

Attributes

Inherited from:
Object
final def triggerHapticPulse(action_name: String, tracker_name: StringName, frequency: Double, amplitude: Double, duration_sec: Double, delay_sec: Double): Unit

XRInterface.trigger_haptic_pulse

XRInterface.trigger_haptic_pulse

Attributes

Inherited from:
XRInterface
final def uninitialize(): Unit

XRInterface.uninitialize

XRInterface.uninitialize

Attributes

Inherited from:
XRInterface
def unref(): Unit

Release one reference this wrapper owns (an engine Ref<T> return, Gd.create, or refInc), destroying the object if it was the last reference. Does nothing when the wrapper owns no reference, so a borrowed object can never be freed from under the engine.

Release one reference this wrapper owns (an engine Ref<T> return, Gd.create, or refInc), destroying the object if it was the last reference. Does nothing when the wrapper owns no reference, so a borrowed object can never be freed from under the engine.

Attributes

Inherited from:
GodotScriptClass
final def unreference(): Boolean

RefCounted.unreference

RefCounted.unreference

Attributes

Inherited from:
RefCounted
final def withHost(o: GDExtensionObjectPtr): this.type

Set the handle and return this (fluent, for wrapping fetched objects).

Set the handle and return this (fluent, for wrapping fetched objects).

Attributes

Inherited from:
GodotScriptClass