Enumerationmigueldeicaza.swiftgodot 0.46.0SwiftGodot
HandTrackedSource
OpenXRInterface.swift:72enum HandTrackedSource
Cases
case unknown
The source of hand tracking data is unknown (the extension is likely unsupported).
case unobstructed
The source of hand tracking is unobstructed, this means that an accurate method of hand tracking is used, e.g. optical hand tracking, data gloves, etc.
case controller
The source of hand tracking is a controller, bone positions are inferred from controller inputs.
case max
Maximum value for the hand tracked source enum.
Other members in extension
View members
Hide members
This section is hidden by default because it contains too many (37) members.
Types
Type members
Instance members
var displayRefreshRate: Double
The display refresh rate for the current HMD. Only functional if this feature is supported by the OpenXR runtime and after the interface has been initialized.
var foveationDynamic: Bool
Enable dynamic foveation adjustment, the interface must be initialized before this is accessible. If enabled foveation will automatically adjusted between low and
foveationLevel
.var foveationLevel: Int32
Set foveation level from 0 (off) to 3 (high), the interface must be initialized before this is accessible.
var instanceExiting: SimpleSignal
Informs our OpenXR instance is exiting.
var poseRecentered: SimpleSignal
Informs the user queued a recenter of the player position.
var refreshRateChanged: Signal1
Informs the user the HMD refresh rate has changed.
var renderTargetSizeMultiplier: Double
The render size multiplier for the current HMD. Must be set before the interface has been initialized.
var sessionBegun: SimpleSignal
Informs our OpenXR session has been started.
var sessionFocussed: SimpleSignal
Informs our OpenXR session now has focus.
var sessionLossPending: SimpleSignal
Informs our OpenXR session is in the process of being lost.
var sessionStopping: SimpleSignal
Informs our OpenXR session is stopping.
var sessionVisible: SimpleSignal
Informs our OpenXR session is now visible (output is being sent to the HMD).
var vrsMinRadius: Double
The minimum radius around the focal point where full quality is guaranteed if VRS is used as a percentage of screen size.
var vrsStrength: Double
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.
func getActionSets(
) -> GArray Returns a list of action sets registered with Godot (loaded from the action map at runtime).
func getAvailableDisplayRefreshRates(
) -> GArray Returns display refresh rates supported by the current HMD. Only returned if this feature is supported by the OpenXR runtime and after the interface has been initialized.
func getHandJointAngularVelocity(hand: OpenXRInterface.Hand, joint: OpenXRInterface.HandJoints
) -> Vector3 If handtracking is enabled, returns the angular velocity of a joint (
joint
) of a hand (hand
) as provided by OpenXR. This is relative toXROrigin3D
!func getHandJointFlags(hand: OpenXRInterface.Hand, joint: OpenXRInterface.HandJoints
) -> OpenXRInterface.HandJointFlags If handtracking is enabled, returns flags that inform us of the validity of the tracking data.
func getHandJointLinearVelocity(hand: OpenXRInterface.Hand, joint: OpenXRInterface.HandJoints
) -> Vector3 If handtracking is enabled, returns the linear velocity of a joint (
joint
) of a hand (hand
) as provided by OpenXR. This is relative toXROrigin3D
without worldscale applied!func getHandJointPosition(hand: OpenXRInterface.Hand, joint: OpenXRInterface.HandJoints
) -> Vector3 If handtracking is enabled, returns the position of a joint (
joint
) of a hand (hand
) as provided by OpenXR. This is relative toXROrigin3D
without worldscale applied!func getHandJointRadius(hand: OpenXRInterface.Hand, joint: OpenXRInterface.HandJoints
) -> Double If handtracking is enabled, returns the radius of a joint (
joint
) of a hand (hand
) as provided by OpenXR. This is without worldscale applied!func getHandJointRotation(hand: OpenXRInterface.Hand, joint: OpenXRInterface.HandJoints
) -> Quaternion If handtracking is enabled, returns the rotation of a joint (
joint
) of a hand (hand
) as provided by OpenXR.func getHandTrackingSource(hand: OpenXRInterface.Hand
) -> OpenXRInterface.HandTrackedSource If handtracking is enabled and hand tracking source is supported, gets the source of the hand tracking data for
hand
.func getMotionRange(hand: OpenXRInterface.Hand
) -> OpenXRInterface.HandMotionRange If handtracking is enabled and motion range is supported, gets the currently configured motion range for
hand
.func isActionSetActive(name: String
) -> Bool Returns
true
if the given action set is active.func isEyeGazeInteractionSupported(
) -> Bool Returns the capabilities of the eye gaze interaction extension.
func isFoveationSupported(
) -> Bool Returns
true
if OpenXR’s foveation extension is supported, the interface must be initialized before this returns a valid value.func isHandInteractionSupported(
) -> Bool Returns
true
if OpenXR’s hand interaction profile is supported and enabled.func isHandTrackingSupported(
) -> Bool Returns
true
if OpenXR’s hand tracking is supported and enabled.func setActionSetActive(name: String, active: Bool
) Sets the given action set as active or inactive.
func setMotionRange(hand: OpenXRInterface.Hand, motionRange: OpenXRInterface.HandMotionRange
) If handtracking is enabled and motion range is supported, sets the currently configured motion range for
hand
tomotionRange
.
Citizens in SwiftGodot
Conformances
protocol CaseIterable
A type that provides a collection of all of its values.
protocol CustomDebugStringConvertible
A type with a customized textual representation suitable for debugging purposes.
protocol Equatable
A type that can be compared for value equality.
protocol Hashable
A type that can be hashed into a
Hasher
to produce an integer hash value.protocol RawRepresentable<RawValue>
A type that can be converted to and from an associated raw value.
Type members
Instance members
var debugDescription: String
A textual representation of this instance, suitable for debugging
Type features
static func != (lhs: Self, rhs: Self
) -> Bool Returns a Boolean value indicating whether two values are not equal.