Version: 2022.3
LanguageEnglish
  • C#

InputDevice.TryGetFeatureValue

Leave feedback
Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Declaration

public bool TryGetFeatureValue(InputFeatureUsage<bool> usage, out bool value);

Declaration

public bool TryGetFeatureValue(InputFeatureUsage<uint> usage, out uint value);

Declaration

public bool TryGetFeatureValue(InputFeatureUsage<float> usage, out float value);

Declaration

public bool TryGetFeatureValue(InputFeatureUsage<Vector2> usage, out Vector2 value);

Declaration

public bool TryGetFeatureValue(InputFeatureUsage<Vector3> usage, out Vector3 value);

Declaration

public bool TryGetFeatureValue(InputFeatureUsage<Quaternion> usage, out Quaternion value);

Declaration

public bool TryGetFeatureValue(InputFeatureUsage<Bone> usage, out XR.Bone value);

Declaration

public bool TryGetFeatureValue(InputFeatureUsage<Hand> usage, out XR.Hand value);

Declaration

public bool TryGetFeatureValue(InputFeatureUsage<Eyes> usage, out XR.Eyes value);

Declaration

public bool TryGetFeatureValue(InputFeatureUsage<InputTrackingState> usage, out XR.InputTrackingState value);

Declaration

public bool TryGetFeatureValue(InputFeatureUsage<bool> usage, DateTime time, out bool value);

Declaration

public bool TryGetFeatureValue(InputFeatureUsage<uint> usage, DateTime time, out uint value);

Declaration

public bool TryGetFeatureValue(InputFeatureUsage<float> usage, DateTime time, out float value);

Declaration

public bool TryGetFeatureValue(InputFeatureUsage<Vector2> usage, DateTime time, out Vector2 value);

Declaration

public bool TryGetFeatureValue(InputFeatureUsage<Vector3> usage, DateTime time, out Vector3 value);

Declaration

public bool TryGetFeatureValue(InputFeatureUsage<Quaternion> usage, DateTime time, out Quaternion value);

Declaration

public bool TryGetFeatureValue(InputFeatureUsage<InputTrackingState> usage, DateTime time, out XR.InputTrackingState value);

Parameters

usage Usage that describes the feature to retrieve.
time A DateTime struct with the local time at which to query for data.
value A variable of the appropriate type to receive the information about the feature.

Returns

bool True if the feature information is retrieved; otherwise false.

Description

Retrieves information about the input feature specified by the Usage parameter. Those functions which take a time parameter allow querying for that feature at a particular point in time

See XR.InputDevice.CommonUsages for valid usages that can be used to retrieve input values. Note: not all of these features will be available on all devices. If a feature is not available this function will return false.

Is something described here not working as you expect it to? It might be a Known Issue. Please check with the Issue Tracker at issuetracker.unity3d.com.

Copyright ©2024 Unity Technologies. Publication Date: 2024-12-20.
Tutorials Community Answers Knowledge Base Forums Asset Store Terms of use Legal Privacy Policy Cookies Do Not Sell or Share My Personal Information