API reference
API reference
Select your platform
No SDKs available
No versions available

OVRInput Class

Provides a unified input system for Oculus controllers and gamepads.

Static Fields

activeControllerType : Controller
Signature 
Controller OVRInput.activeControllerType
AXIS_AS_BUTTON_THRESHOLD : readonly float
Signature 
readonly float OVRInput.AXIS_AS_BUTTON_THRESHOLD
AXIS_DEADZONE_THRESHOLD : readonly float
Signature 
readonly float OVRInput.AXIS_DEADZONE_THRESHOLD
connectedControllerTypes : Controller
Signature 
Controller OVRInput.connectedControllerTypes
controllers : List< OVRControllerBase >
Signature 
List<OVRControllerBase> OVRInput.controllers
fixedUpdateCount : int
Signature 
int OVRInput.fixedUpdateCount
openVRControllerDetails : OpenVRControllerDetails[]
Signature 
OpenVRControllerDetails [] OVRInput.openVRControllerDetails
stepType : OVRPlugin.Step
Signature 
OVRPlugin.Step OVRInput.stepType

Properties

pluginSupportsActiveController : bool
[Get]
Signature 
bool OVRInput.pluginSupportsActiveController

Static Methods

AreHandPosesGeneratedByControllerData ( stepId , hand )
Returns a flag indicating whether or not the hand poses are controlled by controller data.
Signature 
static bool OVRInput.AreHandPosesGeneratedByControllerData(OVRPlugin.Step stepId, OVRInput.Hand hand)
Parameters
stepId: OVRPlugin.Step
hand: OVRInput.Hand
Returns
bool
DisableSimultaneousHandsAndControllers ()
Switch back from simultaneous hands and controllers mode to the app config-specified mono-modality mode on device.
Signature 
static bool OVRInput.DisableSimultaneousHandsAndControllers()
Returns
bool
EnableSimultaneousHandsAndControllers ()
Switch to simultaneous hands and controllers mode on device.
Signature 
static bool OVRInput.EnableSimultaneousHandsAndControllers()
Returns
bool
FixedUpdate ()
Updates the internal physics state of OVRInput.
Must be called manually if used independently from OVRManager.
Signature 
static void OVRInput.FixedUpdate()
Returns
void
Get ( virtualMask , controllerMask )
Gets the current state of the given virtual button mask with the given controller mask.
Returns true if any masked button is down on any masked controller.
Signature 
static bool OVRInput.Get(Button virtualMask, Controller controllerMask=Controller.Active)
Parameters
virtualMask: Button
controllerMask: Controller
Returns
bool
Get ( rawMask , controllerMask )
Gets the current state of the given raw button mask with the given controller mask.
Returns true if any masked button is down on any masked controllers.
Signature 
static bool OVRInput.Get(RawButton rawMask, Controller controllerMask=Controller.Active)
Parameters
rawMask: RawButton
controllerMask: Controller
Returns
bool
Get ( virtualMask , controllerMask )
Gets the current state of the given virtual touch mask with the given controller mask.
Returns true if any masked touch is down on any masked controller.
Signature 
static bool OVRInput.Get(Touch virtualMask, Controller controllerMask=Controller.Active)
Parameters
virtualMask: Touch
controllerMask: Controller
Returns
bool
Get ( rawMask , controllerMask )
Gets the current state of the given raw touch mask with the given controller mask.
Returns true if any masked touch is down on any masked controllers.
Signature 
static bool OVRInput.Get(RawTouch rawMask, Controller controllerMask=Controller.Active)
Parameters
rawMask: RawTouch
controllerMask: Controller
Returns
bool
Get ( virtualMask , controllerMask )
Gets the current state of the given virtual near touch mask with the given controller mask.
Returns true if any masked near touch is down on any masked controller.
Signature 
static bool OVRInput.Get(NearTouch virtualMask, Controller controllerMask=Controller.Active)
Parameters
virtualMask: NearTouch
controllerMask: Controller
Returns
bool
Get ( rawMask , controllerMask )
Gets the current state of the given raw near touch mask with the given controller mask.
Returns true if any masked near touch is down on any masked controllers.
Signature 
static bool OVRInput.Get(RawNearTouch rawMask, Controller controllerMask=Controller.Active)
Parameters
rawMask: RawNearTouch
controllerMask: Controller
Returns
bool
Get ( virtualMask , controllerMask )
Gets the current state of the given virtual 1-dimensional axis mask on the given controller mask.
Returns the value of the largest masked axis across all masked controllers. Values range from 0 to 1.
Signature 
static float OVRInput.Get(Axis1D virtualMask, Controller controllerMask=Controller.Active)
Parameters
virtualMask: Axis1D
controllerMask: Controller
Returns
float
Get ( rawMask , controllerMask )
Gets the current state of the given raw 1-dimensional axis mask on the given controller mask.
Returns the value of the largest masked axis across all masked controllers. Values range from 0 to 1.
Signature 
static float OVRInput.Get(RawAxis1D rawMask, Controller controllerMask=Controller.Active)
Parameters
rawMask: RawAxis1D
controllerMask: Controller
Returns
float
Get ( virtualMask , controllerMask )
Gets the current state of the given virtual 2-dimensional axis mask on the given controller mask.
Returns the vector of the largest masked axis across all masked controllers. Values range from -1 to 1.
Signature 
static Vector2 OVRInput.Get(Axis2D virtualMask, Controller controllerMask=Controller.Active)
Parameters
virtualMask: Axis2D
controllerMask: Controller
Returns
Vector2
Get ( rawMask , controllerMask )
Gets the current state of the given raw 2-dimensional axis mask on the given controller mask.
Returns the vector of the largest masked axis across all masked controllers. Values range from -1 to 1.
Signature 
static Vector2 OVRInput.Get(RawAxis2D rawMask, Controller controllerMask=Controller.Active)
Parameters
rawMask: RawAxis2D
controllerMask: Controller
Returns
Vector2
GetActiveController ()
Returns the current active controller type.
Signature 
static Controller OVRInput.GetActiveController()
Returns
Controller
GetActiveControllerForHand ( handedness )
Gets the active controller type for the given handedness.
Signature 
static OVRInput.Controller OVRInput.GetActiveControllerForHand(Handedness handedness)
Parameters
handedness: Handedness
Returns
OVRInput.Controller
GetConnectedControllers ()
Returns a mask of all currently connected controller types.
Signature 
static Controller OVRInput.GetConnectedControllers()
Returns
Controller
GetControllerBatteryPercentRemaining ( controllerMask )
Returns the battery percentage remaining for the specified controller.
Values range from 0 to 100. Only applicable to controllers that report battery level. Returns 0 for controllers that do not report battery level.
Signature 
static byte OVRInput.GetControllerBatteryPercentRemaining(Controller controllerMask=Controller.Active)
Parameters
controllerMask: Controller
Returns
byte
GetControllerIsInHandState ( hand )
Returns a flag indicating whether or not the controller is held.
Signature 
static ControllerInHandState OVRInput.GetControllerIsInHandState(OVRInput.Hand hand)
Parameters
hand: OVRInput.Hand
Returns
ControllerInHandState
GetControllerOrientationTracked ( controllerType )
Returns true if the given Controller's orientation is currently tracked.
Only supported for Oculus LTouch and RTouch controllers. Non-tracked controllers will return false.
Signature 
static bool OVRInput.GetControllerOrientationTracked(OVRInput.Controller controllerType)
Parameters
controllerType: OVRInput.Controller
Returns
bool
GetControllerOrientationValid ( controllerType )
Returns true if the given Controller's orientation is currently valid.
Only supported for Oculus LTouch and RTouch controllers. Non-tracked controllers will return false.
Signature 
static bool OVRInput.GetControllerOrientationValid(OVRInput.Controller controllerType)
Parameters
controllerType: OVRInput.Controller
Returns
bool
GetControllerPositionTracked ( controllerType )
Returns true if the given Controller's position is currently tracked.
Only supported for Oculus LTouch and RTouch controllers. Non-tracked controllers will return false.
Signature 
static bool OVRInput.GetControllerPositionTracked(OVRInput.Controller controllerType)
Parameters
controllerType: OVRInput.Controller
Returns
bool
GetControllerPositionValid ( controllerType )
Returns true if the given Controller's position is currently valid.
Only supported for Oculus LTouch and RTouch controllers. Non-tracked controllers will return false.
Signature 
static bool OVRInput.GetControllerPositionValid(OVRInput.Controller controllerType)
Parameters
controllerType: OVRInput.Controller
Returns
bool
GetControllerSampleRateHz ( controllerMask )
Signature 
static float OVRInput.GetControllerSampleRateHz(Controller controllerMask=Controller.Active)
Parameters
controllerMask: Controller
Returns
float
GetCurrentInteractionProfile ( hand )
Returns the the current interaction profile for a given hand.
This can be used to distinguish between Touch and Touch Pro controllers.
Signature 
static OVRInput.InteractionProfile OVRInput.GetCurrentInteractionProfile(OVRInput.Hand hand)
Parameters
hand: OVRInput.Hand
Returns
OVRInput.InteractionProfile
GetDominantHand ()
Gets the dominant hand that the user has specified in settings, for mobile devices.
Signature 
static Handedness OVRInput.GetDominantHand()
Returns
Handedness
GetDown ( virtualMask , controllerMask )
Gets the current down state of the given virtual button mask with the given controller mask.
Returns true if any masked button was pressed this frame on any masked controller and no masked button was previously down last frame.
Signature 
static bool OVRInput.GetDown(Button virtualMask, Controller controllerMask=Controller.Active)
Parameters
virtualMask: Button
controllerMask: Controller
Returns
bool
GetDown ( rawMask , controllerMask )
Gets the current down state of the given raw button mask with the given controller mask.
Returns true if any masked button was pressed this frame on any masked controller and no masked button was previously down last frame.
Signature 
static bool OVRInput.GetDown(RawButton rawMask, Controller controllerMask=Controller.Active)
Parameters
rawMask: RawButton
controllerMask: Controller
Returns
bool
GetDown ( virtualMask , controllerMask )
Gets the current down state of the given virtual touch mask with the given controller mask.
Returns true if any masked touch was pressed this frame on any masked controller and no masked touch was previously down last frame.
Signature 
static bool OVRInput.GetDown(Touch virtualMask, Controller controllerMask=Controller.Active)
Parameters
virtualMask: Touch
controllerMask: Controller
Returns
bool
GetDown ( rawMask , controllerMask )
Gets the current down state of the given raw touch mask with the given controller mask.
Returns true if any masked touch was pressed this frame on any masked controller and no masked touch was previously down last frame.
Signature 
static bool OVRInput.GetDown(RawTouch rawMask, Controller controllerMask=Controller.Active)
Parameters
rawMask: RawTouch
controllerMask: Controller
Returns
bool
GetDown ( virtualMask , controllerMask )
Gets the current down state of the given virtual near touch mask with the given controller mask.
Returns true if any masked near touch was pressed this frame on any masked controller and no masked near touch was previously down last frame.
Signature 
static bool OVRInput.GetDown(NearTouch virtualMask, Controller controllerMask=Controller.Active)
Parameters
virtualMask: NearTouch
controllerMask: Controller
Returns
bool
GetDown ( rawMask , controllerMask )
Gets the current down state of the given raw near touch mask with the given controller mask.
Returns true if any masked near touch was pressed this frame on any masked controller and no masked near touch was previously down last frame.
Signature 
static bool OVRInput.GetDown(RawNearTouch rawMask, Controller controllerMask=Controller.Active)
Parameters
rawMask: RawNearTouch
controllerMask: Controller
Returns
bool
GetLocalControllerAcceleration ( controllerType )
(Deprecated) Gets the linear acceleration of the given Controller local to its tracking space.
Only supported for Oculus LTouch and RTouch controllers. Non-tracked controllers will return Vector3.zero.
Signature 
static Vector3 OVRInput.GetLocalControllerAcceleration(OVRInput.Controller controllerType)
Parameters
controllerType: OVRInput.Controller
Returns
Vector3
GetLocalControllerAngularAcceleration ( controllerType )
(Deprecated) Gets the angular acceleration of the given Controller local to its tracking space in radians per second per second around each axis.
Only supported for Oculus LTouch and RTouch controllers. Non-tracked controllers will return Vector3.zero.
Signature 
static Vector3 OVRInput.GetLocalControllerAngularAcceleration(OVRInput.Controller controllerType)
Parameters
controllerType: OVRInput.Controller
Returns
Vector3
GetLocalControllerAngularVelocity ( controllerType )
Gets the angular velocity of the given Controller local to its tracking space in radians per second around each axis.
Only supported for Oculus LTouch and RTouch controllers. Non-tracked controllers will return Vector3.zero.
Signature 
static Vector3 OVRInput.GetLocalControllerAngularVelocity(OVRInput.Controller controllerType)
Parameters
controllerType: OVRInput.Controller
Returns
Vector3
GetLocalControllerPosition ( controllerType )
Gets the position of the given Controller local to its tracking space.
Only supported for Oculus LTouch and RTouch controllers. Non-tracked controllers will return Vector3.zero.
Signature 
static Vector3 OVRInput.GetLocalControllerPosition(OVRInput.Controller controllerType)
Parameters
controllerType: OVRInput.Controller
Returns
Vector3
GetLocalControllerRotation ( controllerType )
Gets the rotation of the given Controller local to its tracking space.
Only supported for Oculus LTouch and RTouch controllers. Non-tracked controllers will return Quaternion.identity.
Signature 
static Quaternion OVRInput.GetLocalControllerRotation(OVRInput.Controller controllerType)
Parameters
controllerType: OVRInput.Controller
Returns
Quaternion
GetLocalControllerStatesWithoutPrediction ( controllerType , position , rotation , velocity , angularVelocity )
Gets the current position, rotation and velocity of given Controller local to its tracking space without prediction.
Only supported for Oculus LTouch and RTouch controllers, when using OpenXR backend
Signature 
static bool OVRInput.GetLocalControllerStatesWithoutPrediction(OVRInput.Controller controllerType, out Vector3 position, out Quaternion rotation, out Vector3 velocity, out Vector3 angularVelocity)
Parameters
controllerType: OVRInput.Controller
position: out Vector3
rotation: out Quaternion
velocity: out Vector3
angularVelocity: out Vector3
Returns
bool
GetLocalControllerVelocity ( controllerType )
Gets the linear velocity of the given Controller local to its tracking space.
Only supported for Oculus LTouch and RTouch controllers. Non-tracked controllers will return Vector3.zero.
Signature 
static Vector3 OVRInput.GetLocalControllerVelocity(OVRInput.Controller controllerType)
Parameters
controllerType: OVRInput.Controller
Returns
Vector3
GetOpenVRStringProperty ( prop , deviceId )
Accesses OpenVR properties about a given deviceID.
Especially useful for differentiating per type of OpenVR device (i.e. Oculus, Vive)
Signature 
static string OVRInput.GetOpenVRStringProperty(OVR.OpenVR.ETrackedDeviceProperty prop, uint deviceId=OVR.OpenVR.OpenVR.k_unTrackedDeviceIndex_Hmd)
Parameters
prop: OVR.OpenVR.ETrackedDeviceProperty
deviceId: uint
Returns
string
GetUp ( virtualMask , controllerMask )
Gets the current up state of the given virtual button mask with the given controller mask.
Returns true if any masked button was released this frame on any masked controller and no other masked button is still down this frame.
Signature 
static bool OVRInput.GetUp(Button virtualMask, Controller controllerMask=Controller.Active)
Parameters
virtualMask: Button
controllerMask: Controller
Returns
bool
GetUp ( rawMask , controllerMask )
Gets the current up state of the given raw button mask with the given controller mask.
Returns true if any masked button was released this frame on any masked controller and no other masked button is still down this frame.
Signature 
static bool OVRInput.GetUp(RawButton rawMask, Controller controllerMask=Controller.Active)
Parameters
rawMask: RawButton
controllerMask: Controller
Returns
bool
GetUp ( virtualMask , controllerMask )
Gets the current up state of the given virtual touch mask with the given controller mask.
Returns true if any masked touch was released this frame on any masked controller and no other masked touch is still down this frame.
Signature 
static bool OVRInput.GetUp(Touch virtualMask, Controller controllerMask=Controller.Active)
Parameters
virtualMask: Touch
controllerMask: Controller
Returns
bool
GetUp ( rawMask , controllerMask )
Gets the current up state of the given raw touch mask with the given controller mask.
Returns true if any masked touch was released this frame on any masked controller and no other masked touch is still down this frame.
Signature 
static bool OVRInput.GetUp(RawTouch rawMask, Controller controllerMask=Controller.Active)
Parameters
rawMask: RawTouch
controllerMask: Controller
Returns
bool
GetUp ( virtualMask , controllerMask )
Gets the current up state of the given virtual near touch mask with the given controller mask.
Returns true if any masked near touch was released this frame on any masked controller and no other masked near touch is still down this frame.
Signature 
static bool OVRInput.GetUp(NearTouch virtualMask, Controller controllerMask=Controller.Active)
Parameters
virtualMask: NearTouch
controllerMask: Controller
Returns
bool
GetUp ( rawMask , controllerMask )
Gets the current up state of the given raw near touch mask with the given controller mask.
Returns true if any masked near touch was released this frame on any masked controller and no other masked near touch is still down this frame.
Signature 
static bool OVRInput.GetUp(RawNearTouch rawMask, Controller controllerMask=Controller.Active)
Parameters
rawMask: RawNearTouch
controllerMask: Controller
Returns
bool
IsControllerConnected ( controller )
Returns true if the specified controller type is currently connected.
Signature 
static bool OVRInput.IsControllerConnected(Controller controller)
Parameters
controller: Controller
Returns
bool
SetControllerHapticsAmplitudeEnvelope ( hapticsVibration , controllerMask )
Signature 
static void OVRInput.SetControllerHapticsAmplitudeEnvelope(HapticsAmplitudeEnvelopeVibration hapticsVibration, Controller controllerMask=Controller.Active)
Parameters
hapticsVibration: HapticsAmplitudeEnvelopeVibration
controllerMask: Controller
Returns
void
SetControllerHapticsPcm ( hapticsVibration , controllerMask )
Signature 
static int OVRInput.SetControllerHapticsPcm(HapticsPcmVibration hapticsVibration, Controller controllerMask=Controller.Active)
Parameters
hapticsVibration: HapticsPcmVibration
controllerMask: Controller
Returns
int
SetControllerLocalizedVibration ( hapticsLocationMask , frequency , amplitude , controllerMask )
Activates vibration with the given frequency and amplitude with the given controller mask.
Ignored on controllers that do not support vibration. Expected values range from 0 to 1.
Signature 
static void OVRInput.SetControllerLocalizedVibration(HapticsLocation hapticsLocationMask, float frequency, float amplitude, Controller controllerMask=Controller.Active)
Parameters
hapticsLocationMask: HapticsLocation
frequency: float
amplitude: float
controllerMask: Controller
Returns
void
SetControllerVibration ( frequency , amplitude , controllerMask )
Activates vibration with the given frequency and amplitude with the given controller mask.
Ignored on controllers that do not support vibration. Expected values range from 0 to 1.
Signature 
static void OVRInput.SetControllerVibration(float frequency, float amplitude, Controller controllerMask=Controller.Active)
Parameters
frequency: float
amplitude: float
controllerMask: Controller
Returns
void
SetOpenVRLocalPose ( leftPos , rightPos , leftRot , rightRot )
Sets OpenVR left and right controller poses local to tracking space.
Signature 
static void OVRInput.SetOpenVRLocalPose(Vector3 leftPos, Vector3 rightPos, Quaternion leftRot, Quaternion rightRot)
Parameters
leftPos: Vector3
rightPos: Vector3
leftRot: Quaternion
rightRot: Quaternion
Returns
void
Update ()
Updates the internal state of OVRInput.
Must be called manually if used independently from OVRManager.
Signature 
static void OVRInput.Update()
Returns
void

Inner Classes

OVRControllerBase Class

Constructors

OVRControllerBase ()
Signature 
OVRInput.OVRControllerBase.OVRControllerBase()

Fields

axis1DMap : VirtualAxis1DMap
Signature 
VirtualAxis1DMap OVRInput.OVRControllerBase.axis1DMap
axis2DMap : VirtualAxis2DMap
Signature 
VirtualAxis2DMap OVRInput.OVRControllerBase.axis2DMap
buttonMap : VirtualButtonMap
Signature 
VirtualButtonMap OVRInput.OVRControllerBase.buttonMap
controllerType : Controller
Signature 
Controller OVRInput.OVRControllerBase.controllerType
currentState : OVRPlugin.ControllerState6
Signature 
OVRPlugin.ControllerState6 OVRInput.OVRControllerBase.currentState
nearTouchMap : VirtualNearTouchMap
Signature 
VirtualNearTouchMap OVRInput.OVRControllerBase.nearTouchMap
previousState : OVRPlugin.ControllerState6
Signature 
OVRPlugin.ControllerState6 OVRInput.OVRControllerBase.previousState
shouldApplyDeadzone : bool
Signature 
bool OVRInput.OVRControllerBase.shouldApplyDeadzone
touchMap : VirtualTouchMap
Signature 
VirtualTouchMap OVRInput.OVRControllerBase.touchMap

Methods

ConfigureAxis1DMap ()
Signature 
abstract void OVRInput.OVRControllerBase.ConfigureAxis1DMap()
Returns
abstract void
ConfigureAxis2DMap ()
Signature 
abstract void OVRInput.OVRControllerBase.ConfigureAxis2DMap()
Returns
abstract void
ConfigureButtonMap ()
Signature 
abstract void OVRInput.OVRControllerBase.ConfigureButtonMap()
Returns
abstract void
ConfigureNearTouchMap ()
Signature 
abstract void OVRInput.OVRControllerBase.ConfigureNearTouchMap()
Returns
abstract void
ConfigureTouchMap ()
Signature 
abstract void OVRInput.OVRControllerBase.ConfigureTouchMap()
Returns
abstract void
GetBatteryPercentRemaining ()
Signature 
virtual byte OVRInput.OVRControllerBase.GetBatteryPercentRemaining()
Returns
byte
GetControllerSampleRateHz ()
Signature 
virtual float OVRInput.OVRControllerBase.GetControllerSampleRateHz()
Returns
float
ResolveToRawMask ( virtualMask )
Signature 
RawButton OVRInput.OVRControllerBase.ResolveToRawMask(Button virtualMask)
Parameters
virtualMask: Button
Returns
RawButton
ResolveToRawMask ( virtualMask )
Signature 
RawTouch OVRInput.OVRControllerBase.ResolveToRawMask(Touch virtualMask)
Parameters
virtualMask: Touch
Returns
RawTouch
ResolveToRawMask ( virtualMask )
Signature 
RawNearTouch OVRInput.OVRControllerBase.ResolveToRawMask(NearTouch virtualMask)
Parameters
virtualMask: NearTouch
Returns
RawNearTouch
ResolveToRawMask ( virtualMask )
Signature 
RawAxis1D OVRInput.OVRControllerBase.ResolveToRawMask(Axis1D virtualMask)
Parameters
virtualMask: Axis1D
Returns
RawAxis1D
ResolveToRawMask ( virtualMask )
Signature 
RawAxis2D OVRInput.OVRControllerBase.ResolveToRawMask(Axis2D virtualMask)
Parameters
virtualMask: Axis2D
Returns
RawAxis2D
SetControllerHapticsAmplitudeEnvelope ( hapticsVibration )
Signature 
virtual void OVRInput.OVRControllerBase.SetControllerHapticsAmplitudeEnvelope(HapticsAmplitudeEnvelopeVibration hapticsVibration)
Parameters
hapticsVibration: HapticsAmplitudeEnvelopeVibration
Returns
void
SetControllerHapticsPcm ( hapticsVibration )
Signature 
virtual int OVRInput.OVRControllerBase.SetControllerHapticsPcm(HapticsPcmVibration hapticsVibration)
Parameters
hapticsVibration: HapticsPcmVibration
Returns
int
SetControllerLocalizedVibration ( hapticsLocationMask , frequency , amplitude )
Signature 
virtual void OVRInput.OVRControllerBase.SetControllerLocalizedVibration(HapticsLocation hapticsLocationMask, float frequency, float amplitude)
Parameters
hapticsLocationMask: HapticsLocation
frequency: float
amplitude: float
Returns
void
SetControllerVibration ( frequency , amplitude )
Signature 
virtual void OVRInput.OVRControllerBase.SetControllerVibration(float frequency, float amplitude)
Parameters
frequency: float
amplitude: float
Returns
void
Update ()
Signature 
virtual Controller OVRInput.OVRControllerBase.Update()
Returns
Controller

Inner Classes

VirtualAxis1DMap Class
Fields
None : RawAxis1D
Signature 
RawAxis1D OVRInput.OVRControllerBase.VirtualAxis1DMap.None
PrimaryHandTrigger : RawAxis1D
Signature 
RawAxis1D OVRInput.OVRControllerBase.VirtualAxis1DMap.PrimaryHandTrigger
PrimaryIndexTrigger : RawAxis1D
Signature 
RawAxis1D OVRInput.OVRControllerBase.VirtualAxis1DMap.PrimaryIndexTrigger
PrimaryIndexTriggerCurl : RawAxis1D
Signature 
RawAxis1D OVRInput.OVRControllerBase.VirtualAxis1DMap.PrimaryIndexTriggerCurl
PrimaryIndexTriggerForce : RawAxis1D
Signature 
RawAxis1D OVRInput.OVRControllerBase.VirtualAxis1DMap.PrimaryIndexTriggerForce
PrimaryIndexTriggerSlide : RawAxis1D
Signature 
RawAxis1D OVRInput.OVRControllerBase.VirtualAxis1DMap.PrimaryIndexTriggerSlide
PrimaryStylusForce : RawAxis1D
Signature 
RawAxis1D OVRInput.OVRControllerBase.VirtualAxis1DMap.PrimaryStylusForce
PrimaryThumbRestForce : RawAxis1D
Signature 
RawAxis1D OVRInput.OVRControllerBase.VirtualAxis1DMap.PrimaryThumbRestForce
SecondaryHandTrigger : RawAxis1D
Signature 
RawAxis1D OVRInput.OVRControllerBase.VirtualAxis1DMap.SecondaryHandTrigger
SecondaryIndexTrigger : RawAxis1D
Signature 
RawAxis1D OVRInput.OVRControllerBase.VirtualAxis1DMap.SecondaryIndexTrigger
SecondaryIndexTriggerCurl : RawAxis1D
Signature 
RawAxis1D OVRInput.OVRControllerBase.VirtualAxis1DMap.SecondaryIndexTriggerCurl
SecondaryIndexTriggerForce : RawAxis1D
Signature 
RawAxis1D OVRInput.OVRControllerBase.VirtualAxis1DMap.SecondaryIndexTriggerForce
SecondaryIndexTriggerSlide : RawAxis1D
Signature 
RawAxis1D OVRInput.OVRControllerBase.VirtualAxis1DMap.SecondaryIndexTriggerSlide
SecondaryStylusForce : RawAxis1D
Signature 
RawAxis1D OVRInput.OVRControllerBase.VirtualAxis1DMap.SecondaryStylusForce
SecondaryThumbRestForce : RawAxis1D
Signature 
RawAxis1D OVRInput.OVRControllerBase.VirtualAxis1DMap.SecondaryThumbRestForce
Methods
ToRawMask ( virtualMask )
Signature 
RawAxis1D OVRInput.OVRControllerBase.VirtualAxis1DMap.ToRawMask(Axis1D virtualMask)
Parameters
virtualMask: Axis1D
Returns
RawAxis1D
VirtualAxis2DMap Class
Fields
None : RawAxis2D
Signature 
RawAxis2D OVRInput.OVRControllerBase.VirtualAxis2DMap.None
PrimaryThumbstick : RawAxis2D
Signature 
RawAxis2D OVRInput.OVRControllerBase.VirtualAxis2DMap.PrimaryThumbstick
PrimaryTouchpad : RawAxis2D
Signature 
RawAxis2D OVRInput.OVRControllerBase.VirtualAxis2DMap.PrimaryTouchpad
SecondaryThumbstick : RawAxis2D
Signature 
RawAxis2D OVRInput.OVRControllerBase.VirtualAxis2DMap.SecondaryThumbstick
SecondaryTouchpad : RawAxis2D
Signature 
RawAxis2D OVRInput.OVRControllerBase.VirtualAxis2DMap.SecondaryTouchpad
Methods
ToRawMask ( virtualMask )
Signature 
RawAxis2D OVRInput.OVRControllerBase.VirtualAxis2DMap.ToRawMask(Axis2D virtualMask)
Parameters
virtualMask: Axis2D
Returns
RawAxis2D
VirtualButtonMap Class
Fields
Back : RawButton
Signature 
RawButton OVRInput.OVRControllerBase.VirtualButtonMap.Back
Down : RawButton
Signature 
RawButton OVRInput.OVRControllerBase.VirtualButtonMap.Down
DpadDown : RawButton
Signature 
RawButton OVRInput.OVRControllerBase.VirtualButtonMap.DpadDown
DpadLeft : RawButton
Signature 
RawButton OVRInput.OVRControllerBase.VirtualButtonMap.DpadLeft
DpadRight : RawButton
Signature 
RawButton OVRInput.OVRControllerBase.VirtualButtonMap.DpadRight
DpadUp : RawButton
Signature 
RawButton OVRInput.OVRControllerBase.VirtualButtonMap.DpadUp
Four : RawButton
Signature 
RawButton OVRInput.OVRControllerBase.VirtualButtonMap.Four
Left : RawButton
Signature 
RawButton OVRInput.OVRControllerBase.VirtualButtonMap.Left
None : RawButton
Signature 
RawButton OVRInput.OVRControllerBase.VirtualButtonMap.None
One : RawButton
Signature 
RawButton OVRInput.OVRControllerBase.VirtualButtonMap.One
PrimaryHandTrigger : RawButton
Signature 
RawButton OVRInput.OVRControllerBase.VirtualButtonMap.PrimaryHandTrigger
PrimaryIndexTrigger : RawButton
Signature 
RawButton OVRInput.OVRControllerBase.VirtualButtonMap.PrimaryIndexTrigger
PrimaryShoulder : RawButton
Signature 
RawButton OVRInput.OVRControllerBase.VirtualButtonMap.PrimaryShoulder
PrimaryThumbstick : RawButton
Signature 
RawButton OVRInput.OVRControllerBase.VirtualButtonMap.PrimaryThumbstick
PrimaryThumbstickDown : RawButton
Signature 
RawButton OVRInput.OVRControllerBase.VirtualButtonMap.PrimaryThumbstickDown
PrimaryThumbstickLeft : RawButton
Signature 
RawButton OVRInput.OVRControllerBase.VirtualButtonMap.PrimaryThumbstickLeft
PrimaryThumbstickRight : RawButton
Signature 
RawButton OVRInput.OVRControllerBase.VirtualButtonMap.PrimaryThumbstickRight
PrimaryThumbstickUp : RawButton
Signature 
RawButton OVRInput.OVRControllerBase.VirtualButtonMap.PrimaryThumbstickUp
PrimaryTouchpad : RawButton
Signature 
RawButton OVRInput.OVRControllerBase.VirtualButtonMap.PrimaryTouchpad
Right : RawButton
Signature 
RawButton OVRInput.OVRControllerBase.VirtualButtonMap.Right
SecondaryHandTrigger : RawButton
Signature 
RawButton OVRInput.OVRControllerBase.VirtualButtonMap.SecondaryHandTrigger
SecondaryIndexTrigger : RawButton
Signature 
RawButton OVRInput.OVRControllerBase.VirtualButtonMap.SecondaryIndexTrigger
SecondaryShoulder : RawButton
Signature 
RawButton OVRInput.OVRControllerBase.VirtualButtonMap.SecondaryShoulder
SecondaryThumbstick : RawButton
Signature 
RawButton OVRInput.OVRControllerBase.VirtualButtonMap.SecondaryThumbstick
SecondaryThumbstickDown : RawButton
Signature 
RawButton OVRInput.OVRControllerBase.VirtualButtonMap.SecondaryThumbstickDown
SecondaryThumbstickLeft : RawButton
Signature 
RawButton OVRInput.OVRControllerBase.VirtualButtonMap.SecondaryThumbstickLeft
SecondaryThumbstickRight : RawButton
Signature 
RawButton OVRInput.OVRControllerBase.VirtualButtonMap.SecondaryThumbstickRight
SecondaryThumbstickUp : RawButton
Signature 
RawButton OVRInput.OVRControllerBase.VirtualButtonMap.SecondaryThumbstickUp
SecondaryTouchpad : RawButton
Signature 
RawButton OVRInput.OVRControllerBase.VirtualButtonMap.SecondaryTouchpad
Start : RawButton
Signature 
RawButton OVRInput.OVRControllerBase.VirtualButtonMap.Start
Three : RawButton
Signature 
RawButton OVRInput.OVRControllerBase.VirtualButtonMap.Three
Two : RawButton
Signature 
RawButton OVRInput.OVRControllerBase.VirtualButtonMap.Two
Signature 
RawButton OVRInput.OVRControllerBase.VirtualButtonMap.Up
Methods
ToRawMask ( virtualMask )
Signature 
RawButton OVRInput.OVRControllerBase.VirtualButtonMap.ToRawMask(Button virtualMask)
Parameters
virtualMask: Button
Returns
RawButton
VirtualNearTouchMap Class
Fields
Signature 
RawNearTouch OVRInput.OVRControllerBase.VirtualNearTouchMap.None
PrimaryIndexTrigger : RawNearTouch
Signature 
RawNearTouch OVRInput.OVRControllerBase.VirtualNearTouchMap.PrimaryIndexTrigger
PrimaryThumbButtons : RawNearTouch
Signature 
RawNearTouch OVRInput.OVRControllerBase.VirtualNearTouchMap.PrimaryThumbButtons
SecondaryIndexTrigger : RawNearTouch
Signature 
RawNearTouch OVRInput.OVRControllerBase.VirtualNearTouchMap.SecondaryIndexTrigger
SecondaryThumbButtons : RawNearTouch
Signature 
RawNearTouch OVRInput.OVRControllerBase.VirtualNearTouchMap.SecondaryThumbButtons
Methods
ToRawMask ( virtualMask )
Signature 
RawNearTouch OVRInput.OVRControllerBase.VirtualNearTouchMap.ToRawMask(NearTouch virtualMask)
Parameters
virtualMask: NearTouch
Returns
RawNearTouch
VirtualTouchMap Class
Fields
Four : RawTouch
Signature 
RawTouch OVRInput.OVRControllerBase.VirtualTouchMap.Four
None : RawTouch
Signature 
RawTouch OVRInput.OVRControllerBase.VirtualTouchMap.None
One : RawTouch
Signature 
RawTouch OVRInput.OVRControllerBase.VirtualTouchMap.One
PrimaryIndexTrigger : RawTouch
Signature 
RawTouch OVRInput.OVRControllerBase.VirtualTouchMap.PrimaryIndexTrigger
PrimaryThumbRest : RawTouch
Signature 
RawTouch OVRInput.OVRControllerBase.VirtualTouchMap.PrimaryThumbRest
PrimaryThumbstick : RawTouch
Signature 
RawTouch OVRInput.OVRControllerBase.VirtualTouchMap.PrimaryThumbstick
PrimaryTouchpad : RawTouch
Signature 
RawTouch OVRInput.OVRControllerBase.VirtualTouchMap.PrimaryTouchpad
SecondaryIndexTrigger : RawTouch
Signature 
RawTouch OVRInput.OVRControllerBase.VirtualTouchMap.SecondaryIndexTrigger
SecondaryThumbRest : RawTouch
Signature 
RawTouch OVRInput.OVRControllerBase.VirtualTouchMap.SecondaryThumbRest
SecondaryThumbstick : RawTouch
Signature 
RawTouch OVRInput.OVRControllerBase.VirtualTouchMap.SecondaryThumbstick
SecondaryTouchpad : RawTouch
Signature 
RawTouch OVRInput.OVRControllerBase.VirtualTouchMap.SecondaryTouchpad
Three : RawTouch
Signature 
RawTouch OVRInput.OVRControllerBase.VirtualTouchMap.Three
Two : RawTouch
Signature 
RawTouch OVRInput.OVRControllerBase.VirtualTouchMap.Two
Methods
ToRawMask ( virtualMask )
Signature 
RawTouch OVRInput.OVRControllerBase.VirtualTouchMap.ToRawMask(Touch virtualMask)
Parameters
virtualMask: Touch
Returns
RawTouch

OVRControllerGamepadPC Class

Extends OVRInput.OVRControllerBase

Constructors

OVRControllerGamepadPC ()
Signature 
OVRInput.OVRControllerGamepadPC.OVRControllerGamepadPC()

Methods

ConfigureAxis1DMap ()
Signature 
override void OVRInput.OVRControllerGamepadPC.ConfigureAxis1DMap()
Returns
override void
ConfigureAxis2DMap ()
Signature 
override void OVRInput.OVRControllerGamepadPC.ConfigureAxis2DMap()
Returns
override void
ConfigureButtonMap ()
Signature 
override void OVRInput.OVRControllerGamepadPC.ConfigureButtonMap()
Returns
override void
ConfigureNearTouchMap ()
Signature 
override void OVRInput.OVRControllerGamepadPC.ConfigureNearTouchMap()
Returns
override void
ConfigureTouchMap ()
Signature 
override void OVRInput.OVRControllerGamepadPC.ConfigureTouchMap()
Returns
override void

OVRControllerHands Class

Extends OVRInput.OVRControllerBase

Constructors

OVRControllerHands ()
Signature 
OVRInput.OVRControllerHands.OVRControllerHands()

Methods

ConfigureAxis1DMap ()
Signature 
override void OVRInput.OVRControllerHands.ConfigureAxis1DMap()
Returns
override void
ConfigureAxis2DMap ()
Signature 
override void OVRInput.OVRControllerHands.ConfigureAxis2DMap()
Returns
override void
ConfigureButtonMap ()
Signature 
override void OVRInput.OVRControllerHands.ConfigureButtonMap()
Returns
override void
ConfigureNearTouchMap ()
Signature 
override void OVRInput.OVRControllerHands.ConfigureNearTouchMap()
Returns
override void
ConfigureTouchMap ()
Signature 
override void OVRInput.OVRControllerHands.ConfigureTouchMap()
Returns
override void
GetBatteryPercentRemaining ()
Signature 
override byte OVRInput.OVRControllerHands.GetBatteryPercentRemaining()
Returns
override byte

OVRControllerLHand Class

Extends OVRInput.OVRControllerBase

Constructors

OVRControllerLHand ()
Signature 
OVRInput.OVRControllerLHand.OVRControllerLHand()

Methods

ConfigureAxis1DMap ()
Signature 
override void OVRInput.OVRControllerLHand.ConfigureAxis1DMap()
Returns
override void
ConfigureAxis2DMap ()
Signature 
override void OVRInput.OVRControllerLHand.ConfigureAxis2DMap()
Returns
override void
ConfigureButtonMap ()
Signature 
override void OVRInput.OVRControllerLHand.ConfigureButtonMap()
Returns
override void
ConfigureNearTouchMap ()
Signature 
override void OVRInput.OVRControllerLHand.ConfigureNearTouchMap()
Returns
override void
ConfigureTouchMap ()
Signature 
override void OVRInput.OVRControllerLHand.ConfigureTouchMap()
Returns
override void
GetBatteryPercentRemaining ()
Signature 
override byte OVRInput.OVRControllerLHand.GetBatteryPercentRemaining()
Returns
override byte

OVRControllerLTouch Class

Extends OVRInput.OVRControllerBase

Constructors

OVRControllerLTouch ()
Signature 
OVRInput.OVRControllerLTouch.OVRControllerLTouch()

Methods

ConfigureAxis1DMap ()
Signature 
override void OVRInput.OVRControllerLTouch.ConfigureAxis1DMap()
Returns
override void
ConfigureAxis2DMap ()
Signature 
override void OVRInput.OVRControllerLTouch.ConfigureAxis2DMap()
Returns
override void
ConfigureButtonMap ()
Signature 
override void OVRInput.OVRControllerLTouch.ConfigureButtonMap()
Returns
override void
ConfigureNearTouchMap ()
Signature 
override void OVRInput.OVRControllerLTouch.ConfigureNearTouchMap()
Returns
override void
ConfigureTouchMap ()
Signature 
override void OVRInput.OVRControllerLTouch.ConfigureTouchMap()
Returns
override void
GetBatteryPercentRemaining ()
Signature 
override byte OVRInput.OVRControllerLTouch.GetBatteryPercentRemaining()
Returns
override byte

OVRControllerRemote Class

Extends OVRInput.OVRControllerBase

Constructors

OVRControllerRemote ()
Signature 
OVRInput.OVRControllerRemote.OVRControllerRemote()

Methods

ConfigureAxis1DMap ()
Signature 
override void OVRInput.OVRControllerRemote.ConfigureAxis1DMap()
Returns
override void
ConfigureAxis2DMap ()
Signature 
override void OVRInput.OVRControllerRemote.ConfigureAxis2DMap()
Returns
override void
ConfigureButtonMap ()
Signature 
override void OVRInput.OVRControllerRemote.ConfigureButtonMap()
Returns
override void
ConfigureNearTouchMap ()
Signature 
override void OVRInput.OVRControllerRemote.ConfigureNearTouchMap()
Returns
override void
ConfigureTouchMap ()
Signature 
override void OVRInput.OVRControllerRemote.ConfigureTouchMap()
Returns
override void

OVRControllerRHand Class

Extends OVRInput.OVRControllerBase

Constructors

OVRControllerRHand ()
Signature 
OVRInput.OVRControllerRHand.OVRControllerRHand()

Methods

ConfigureAxis1DMap ()
Signature 
override void OVRInput.OVRControllerRHand.ConfigureAxis1DMap()
Returns
override void
ConfigureAxis2DMap ()
Signature 
override void OVRInput.OVRControllerRHand.ConfigureAxis2DMap()
Returns
override void
ConfigureButtonMap ()
Signature 
override void OVRInput.OVRControllerRHand.ConfigureButtonMap()
Returns
override void
ConfigureNearTouchMap ()
Signature 
override void OVRInput.OVRControllerRHand.ConfigureNearTouchMap()
Returns
override void
ConfigureTouchMap ()
Signature 
override void OVRInput.OVRControllerRHand.ConfigureTouchMap()
Returns
override void
GetBatteryPercentRemaining ()
Signature 
override byte OVRInput.OVRControllerRHand.GetBatteryPercentRemaining()
Returns
override byte

OVRControllerTouch Class

Extends OVRInput.OVRControllerBase

Constructors

OVRControllerTouch ()
Signature 
OVRInput.OVRControllerTouch.OVRControllerTouch()

Methods

ConfigureAxis1DMap ()
Signature 
override void OVRInput.OVRControllerTouch.ConfigureAxis1DMap()
Returns
override void
ConfigureAxis2DMap ()
Signature 
override void OVRInput.OVRControllerTouch.ConfigureAxis2DMap()
Returns
override void
ConfigureButtonMap ()
Signature 
override void OVRInput.OVRControllerTouch.ConfigureButtonMap()
Returns
override void
ConfigureNearTouchMap ()
Signature 
override void OVRInput.OVRControllerTouch.ConfigureNearTouchMap()
Returns
override void
ConfigureTouchMap ()
Signature 
override void OVRInput.OVRControllerTouch.ConfigureTouchMap()
Returns
override void
GetBatteryPercentRemaining ()
Signature 
override byte OVRInput.OVRControllerTouch.GetBatteryPercentRemaining()
Returns
override byte

Inner Structs

HapticsAmplitudeEnvelopeVibration Struct

Fields

Duration : float
Signature 
float OVRInput.HapticsAmplitudeEnvelopeVibration.Duration
Samples : float[]
Signature 
float [] OVRInput.HapticsAmplitudeEnvelopeVibration.Samples
SamplesCount : int
Signature 
int OVRInput.HapticsAmplitudeEnvelopeVibration.SamplesCount

HapticsPcmVibration Struct

Fields

Append : bool
Signature 
bool OVRInput.HapticsPcmVibration.Append
SampleRateHz : float
Signature 
float OVRInput.HapticsPcmVibration.SampleRateHz
Samples : float[]
Signature 
float [] OVRInput.HapticsPcmVibration.Samples
SamplesCount : int
Signature 
int OVRInput.HapticsPcmVibration.SamplesCount

OpenVRControllerDetails Struct

Fields

controllerType : OpenVRController
Signature 
OpenVRController OVRInput.OpenVRControllerDetails.controllerType
deviceID : uint
Signature 
uint OVRInput.OpenVRControllerDetails.deviceID
localOrientation : Quaternion
Signature 
Quaternion OVRInput.OpenVRControllerDetails.localOrientation
localPosition : Vector3
Signature 
Vector3 OVRInput.OpenVRControllerDetails.localPosition
state : OVR.OpenVR.VRControllerState_t
Signature 
OVR.OpenVR.VRControllerState_t OVRInput.OpenVRControllerDetails.state

Inner Enums

Button Enum

Virtual button mappings that allow the same input bindings to work across different controllers.

Enumeration Constants

MemberValueDescription
None
0
Maps to RawButton: [Gamepad, Touch, LTouch, RTouch, Remote: None].
One
0x00000001
Maps to RawButton: [Gamepad, Touch, RTouch: A], [LTouch: X], [Remote: Start].
Two
0x00000002
Maps to RawButton: [Gamepad, Touch, RTouch: B], [LTouch: Y], [Remote: Back].
Three
0x00000004
Maps to RawButton: [Gamepad, Touch: X], [LTouch, RTouch, Remote: None].
Four
0x00000008
Maps to RawButton: [Gamepad, Touch: Y], [LTouch, RTouch, Remote: None].
Start
0x00000100
Maps to RawButton: [Gamepad: Start], [Touch, LTouch, Remote: Start], [RTouch: None].
Back
0x00000200
Maps to RawButton: [Gamepad, Remote: Back], [Touch, LTouch, RTouch: None].
PrimaryShoulder
0x00001000
Maps to RawButton: [Gamepad: LShoulder], [Touch, LTouch, RTouch, Remote: None].
PrimaryIndexTrigger
0x00002000
Maps to RawButton: [Gamepad, Touch, LTouch: LIndexTrigger], [RTouch: RIndexTrigger], [Remote: None].
PrimaryHandTrigger
0x00004000
Maps to RawButton: [Touch, LTouch: LHandTrigger], [RTouch: RHandTrigger], [Gamepad, Remote: None].
PrimaryThumbstick
0x00008000
Maps to RawButton: [Gamepad, Touch, LTouch: LThumbstick], [RTouch: RThumbstick], [Remote: None].
PrimaryThumbstickUp
0x00010000
Maps to RawButton: [Gamepad, Touch, LTouch: LThumbstickUp], [RTouch: RThumbstickUp], [Remote: None].
PrimaryThumbstickDown
0x00020000
Maps to RawButton: [Gamepad, Touch, LTouch: LThumbstickDown], [RTouch: RThumbstickDown], [Remote: None].
PrimaryThumbstickLeft
0x00040000
Maps to RawButton: [Gamepad, Touch, LTouch: LThumbstickLeft], [RTouch: RThumbstickLeft], [Remote: None].
PrimaryThumbstickRight
0x00080000
Maps to RawButton: [Gamepad, Touch, LTouch: LThumbstickRight], [RTouch: RThumbstickRight], [Remote: None].
PrimaryTouchpad
0x00000400
Maps to RawButton: [Gamepad, Touch, LTouch, RTouch, Remote: None].
SecondaryShoulder
0x00100000
Maps to RawButton: [Gamepad: RShoulder], [Touch, LTouch, RTouch, Remote: None].
SecondaryIndexTrigger
0x00200000
Maps to RawButton: [Gamepad, Touch: RIndexTrigger], [LTouch, RTouch, Remote: None].
SecondaryHandTrigger
0x00400000
Maps to RawButton: [Touch: RHandTrigger], [Gamepad, LTouch, RTouch, Remote: None].
SecondaryThumbstick
0x00800000
Maps to RawButton: [Gamepad, Touch: RThumbstick], [LTouch, RTouch, Remote: None].
SecondaryThumbstickUp
0x01000000
Maps to RawButton: [Gamepad, Touch: RThumbstickUp], [LTouch, RTouch, Remote: None].
SecondaryThumbstickDown
0x02000000
Maps to RawButton: [Gamepad, Touch: RThumbstickDown], [LTouch, RTouch, Remote: None].
SecondaryThumbstickLeft
0x04000000
Maps to RawButton: [Gamepad, Touch: RThumbstickLeft], [LTouch, RTouch, Remote: None].
SecondaryThumbstickRight
0x08000000
Maps to RawButton: [Gamepad, Touch: RThumbstickRight], [LTouch, RTouch, Remote: None].
SecondaryTouchpad
0x00000800
Maps to RawButton: [Gamepad, Touch, LTouch, RTouch, Remote: None].
DpadUp
0x00000010
Maps to RawButton: [Gamepad, Remote: DpadUp], [Touch, LTouch, RTouch: None].
DpadDown
0x00000020
Maps to RawButton: [Gamepad, Remote: DpadDown], [Touch, LTouch, RTouch: None].
DpadLeft
0x00000040
Maps to RawButton: [Gamepad, Remote: DpadLeft], [Touch, LTouch, RTouch: None].
DpadRight
0x00000080
Maps to RawButton: [Gamepad, Remote: DpadRight], [Touch, LTouch, RTouch: None].
Up
0x10000000
Maps to RawButton: [Gamepad, Touch, LTouch: LThumbstickUp], [RTouch: RThumbstickUp], [Remote: DpadUp].
Down
0x20000000
Maps to RawButton: [Gamepad, Touch, LTouch: LThumbstickDown], [RTouch: RThumbstickDown], [Remote: DpadDown].
Left
0x40000000
Maps to RawButton: [Gamepad, Touch, LTouch: LThumbstickLeft], [RTouch: RThumbstickLeft], [Remote: DpadLeft].
Right
unchecked((int)0x80000000)
Maps to RawButton: [Gamepad, Touch, LTouch: LThumbstickRight], [RTouch: RThumbstickRight], [Remote: DpadRight].
Any
~None
Maps to RawButton: [Gamepad, Touch, LTouch, RTouch: Any].

RawButton Enum

Raw button mappings that can be used to directly query the state of a controller.

Enumeration Constants

MemberValueDescription
None
0
Maps to Physical Button: [Gamepad, Touch, LTouch, RTouch, Remote: None].
A
0x00000001
Maps to Physical Button: [Gamepad, Touch, RTouch: A], [LTouch, Remote: None].
B
0x00000002
Maps to Physical Button: [Gamepad, Touch, RTouch: B], [LTouch, Remote: None].
X
0x00000100
Maps to Physical Button: [Gamepad, Touch, LTouch: X], [RTouch, Remote: None].
Y
0x00000200
Maps to Physical Button: [Gamepad, Touch, LTouch: Y], [RTouch, Remote: None].
Start
0x00100000
Maps to Physical Button: [Gamepad, Touch, LTouch, Remote: Start], [RTouch: None].
Back
0x00200000
Maps to Physical Button: [Gamepad, Remote: Back], [Touch, LTouch, RTouch: None].
LShoulder
0x00000800
Maps to Physical Button: [Gamepad: LShoulder], [Touch, LTouch, RTouch, Remote: None].
LIndexTrigger
0x10000000
Maps to Physical Button: [Gamepad, Touch, LTouch: LIndexTrigger], [RTouch, Remote: None].
LHandTrigger
0x20000000
Maps to Physical Button: [Touch, LTouch: LHandTrigger], [Gamepad, RTouch, Remote: None].
LThumbstick
0x00000400
Maps to Physical Button: [Gamepad, Touch, LTouch: LThumbstick], [RTouch, Remote: None].
LThumbstickUp
0x00000010
Maps to Physical Button: [Gamepad, Touch, LTouch: LThumbstickUp], [RTouch, Remote: None].
LThumbstickDown
0x00000020
Maps to Physical Button: [Gamepad, Touch, LTouch: LThumbstickDown], [RTouch, Remote: None].
LThumbstickLeft
0x00000040
Maps to Physical Button: [Gamepad, Touch, LTouch: LThumbstickLeft], [RTouch, Remote: None].
LThumbstickRight
0x00000080
Maps to Physical Button: [Gamepad, Touch, LTouch: LThumbstickRight], [RTouch, Remote: None].
LTouchpad
0x40000000
Maps to Physical Button: [Gamepad, Touch, LTouch, RTouch, Remote: None].
RShoulder
0x00000008
Maps to Physical Button: [Gamepad: RShoulder], [Touch, LTouch, RTouch, Remote: None].
RIndexTrigger
0x04000000
Maps to Physical Button: [Gamepad, Touch, RTouch: RIndexTrigger], [LTouch, Remote: None].
RHandTrigger
0x08000000
Maps to Physical Button: [Touch, RTouch: RHandTrigger], [Gamepad, LTouch, Remote: None].
RThumbstick
0x00000004
Maps to Physical Button: [Gamepad, Touch, RTouch: RThumbstick], [LTouch, Remote: None].
RThumbstickUp
0x00001000
Maps to Physical Button: [Gamepad, Touch, RTouch: RThumbstickUp], [LTouch, Remote: None].
RThumbstickDown
0x00002000
Maps to Physical Button: [Gamepad, Touch, RTouch: RThumbstickDown], [LTouch, Remote: None].
RThumbstickLeft
0x00004000
Maps to Physical Button: [Gamepad, Touch, RTouch: RThumbstickLeft], [LTouch, Remote: None].
RThumbstickRight
0x00008000
Maps to Physical Button: [Gamepad, Touch, RTouch: RThumbstickRight], [LTouch, Remote: None].
RTouchpad
unchecked((int)0x80000000)
Maps to Physical Button: [Gamepad, Touch, LTouch, RTouch, Remote: None].
DpadUp
0x00010000
Maps to Physical Button: [Gamepad, Remote: DpadUp], [Touch, LTouch, RTouch: None].
DpadDown
0x00020000
Maps to Physical Button: [Gamepad, Remote: DpadDown], [Touch, LTouch, RTouch: None].
DpadLeft
0x00040000
Maps to Physical Button: [Gamepad, Remote: DpadLeft], [Touch, LTouch, RTouch: None].
DpadRight
0x00080000
Maps to Physical Button: [Gamepad, Remote: DpadRight], [Touch, LTouch, RTouch: None].
Any
~None
Maps to Physical Button: [Gamepad, Touch, LTouch, RTouch, Remote: Any].

Touch Enum

Virtual capacitive touch mappings that allow the same input bindings to work across different controllers with capacitive touch support.

Enumeration Constants

MemberValueDescription
None
0
Maps to RawTouch: [Gamepad, Touch, LTouch, RTouch, Remote: None].
One
Button.One
Maps to RawTouch: [Touch, RTouch: A], [LTouch: X], [Gamepad, Remote: None].
Two
Button.Two
Maps to RawTouch: [Touch, RTouch: B], [LTouch: Y], [Gamepad, Remote: None].
Three
Button.Three
Maps to RawTouch: [Touch: X], [Gamepad, LTouch, RTouch, Remote: None].
Four
Button.Four
Maps to RawTouch: [Touch: Y], [Gamepad, LTouch, RTouch, Remote: None].
PrimaryIndexTrigger
Button.PrimaryIndexTrigger
Maps to RawTouch: [Touch, LTouch: LIndexTrigger], [RTouch: RIndexTrigger], [Gamepad, Remote: None].
PrimaryThumbstick
Button.PrimaryThumbstick
Maps to RawTouch: [Touch, LTouch: LThumbstick], [RTouch: RThumbstick], [Gamepad, Remote: None].
PrimaryThumbRest
0x00001000
Maps to RawTouch: [Touch, LTouch: LThumbRest], [RTouch: RThumbRest], [Gamepad, Remote: None].
PrimaryTouchpad
Button.PrimaryTouchpad
Maps to RawTouch: [Gamepad, Touch, LTouch, RTouch, Remote: None].
SecondaryIndexTrigger
Button.SecondaryIndexTrigger
Maps to RawTouch: [Touch: RIndexTrigger], [Gamepad, LTouch, RTouch, Remote: None].
SecondaryThumbstick
Button.SecondaryThumbstick
Maps to RawTouch: [Touch: RThumbstick], [Gamepad, LTouch, RTouch, Remote: None].
SecondaryThumbRest
0x00100000
Maps to RawTouch: [Touch: RThumbRest], [Gamepad, LTouch, RTouch, Remote: None].
SecondaryTouchpad
Button.SecondaryTouchpad
Maps to RawTouch: [Gamepad, Touch, LTouch, RTouch, Remote: None].
Any
~None
Maps to RawTouch: [Touch, LTouch, RTouch: Any], [Gamepad, Remote: None].

RawTouch Enum

Raw capacitive touch mappings that can be used to directly query the state of a controller.

Enumeration Constants

MemberValueDescription
None
0
Maps to Physical Touch: [Gamepad, Touch, LTouch, RTouch, Remote: None].
A
RawButton.A
Maps to Physical Touch: [Touch, RTouch: A], [Gamepad, LTouch, Remote: None].
B
RawButton.B
Maps to Physical Touch: [Touch, RTouch: B], [Gamepad, LTouch, Remote: None].
X
RawButton.X
Maps to Physical Touch: [Touch, LTouch: X], [Gamepad, RTouch, Remote: None].
Y
RawButton.Y
Maps to Physical Touch: [Touch, LTouch: Y], [Gamepad, RTouch, Remote: None].
LIndexTrigger
0x00001000
Maps to Physical Touch: [Touch, LTouch: LIndexTrigger], [Gamepad, RTouch, Remote: None].
LThumbstick
RawButton.LThumbstick
Maps to Physical Touch: [Touch, LTouch: LThumbstick], [Gamepad, RTouch, Remote: None].
LThumbRest
0x00000800
Maps to Physical Touch: [Touch, LTouch: LThumbRest], [Gamepad, RTouch, Remote: None].
LTouchpad
RawButton.LTouchpad
Maps to Physical Touch: [Gamepad, Touch, LTouch, RTouch, Remote: None].
RIndexTrigger
0x00000010
Maps to Physical Touch: [Touch, RTouch: RIndexTrigger], [Gamepad, LTouch, Remote: None].
RThumbstick
RawButton.RThumbstick
Maps to Physical Touch: [Touch, RTouch: RThumbstick], [Gamepad, LTouch, Remote: None].
RThumbRest
0x00000008
Maps to Physical Touch: [Touch, RTouch: RThumbRest], [Gamepad, LTouch, Remote: None].
RTouchpad
RawButton.RTouchpad
Maps to Physical Touch: [Gamepad, Touch, LTouch, RTouch, Remote: None].
Any
~None
Maps to Physical Touch: [Touch, LTouch, RTouch: Any], [Gamepad, Remote: None].

NearTouch Enum

Virtual near touch mappings that allow the same input bindings to work across different controllers with near touch support.
A near touch uses the capacitive touch sensors of a controller to detect approximate finger proximity prior to a full touch being reported.

Enumeration Constants

MemberValueDescription
None
0
Maps to RawNearTouch: [Gamepad, Touch, LTouch, RTouch, Remote: None].
PrimaryIndexTrigger
0x00000001
Maps to RawNearTouch: [Touch, LTouch: LIndexTrigger], [RTouch: RIndexTrigger], [Gamepad, Remote: None].
PrimaryThumbButtons
0x00000002
Maps to RawNearTouch: [Touch, LTouch: LThumbButtons], [RTouch: RThumbButtons], [Gamepad, Remote: None].
SecondaryIndexTrigger
0x00000004
Maps to RawNearTouch: [Touch: RIndexTrigger], [Gamepad, LTouch, RTouch, Remote: None].
SecondaryThumbButtons
0x00000008
Maps to RawNearTouch: [Touch: RThumbButtons], [Gamepad, LTouch, RTouch, Remote: None].
Any
~None
Maps to RawNearTouch: [Touch, LTouch, RTouch: Any], [Gamepad, Remote: None].

RawNearTouch Enum

Raw near touch mappings that can be used to directly query the state of a controller.

Enumeration Constants

MemberValueDescription
None
0
Maps to Physical NearTouch: [Gamepad, Touch, LTouch, RTouch, Remote: None].
LIndexTrigger
0x00000001
Maps to Physical NearTouch: [Touch, LTouch: Implies finger is in close proximity to LIndexTrigger.], [Gamepad, RTouch, Remote: None].
LThumbButtons
0x00000002
Maps to Physical NearTouch: [Touch, LTouch: Implies thumb is in close proximity to LThumbstick OR X/Y buttons.], [Gamepad, RTouch, Remote: None].
RIndexTrigger
0x00000004
Maps to Physical NearTouch: [Touch, RTouch: Implies finger is in close proximity to RIndexTrigger.], [Gamepad, LTouch, Remote: None].
RThumbButtons
0x00000008
Maps to Physical NearTouch: [Touch, RTouch: Implies thumb is in close proximity to RThumbstick OR A/B buttons.], [Gamepad, LTouch, Remote: None].
Any
~None
Maps to Physical NearTouch: [Touch, LTouch, RTouch: Any], [Gamepad, Remote: None].

Axis1D Enum

Virtual 1-dimensional axis (float) mappings that allow the same input bindings to work across different controllers.

Enumeration Constants

MemberValueDescription
None
0
Maps to RawAxis1D: [Gamepad, Touch, LTouch, RTouch, Remote: None].
PrimaryIndexTrigger
0x01
Maps to RawAxis1D: [Gamepad, Touch, LTouch: LIndexTrigger], [RTouch: RIndexTrigger], [Remote: None].
PrimaryHandTrigger
0x04
Maps to RawAxis1D: [Touch, LTouch: LHandTrigger], [RTouch: RHandTrigger], [Gamepad, Remote: None].
SecondaryIndexTrigger
0x02
Maps to RawAxis1D: [Gamepad, Touch: RIndexTrigger], [LTouch, RTouch, Remote: None].
SecondaryHandTrigger
0x08
Maps to RawAxis1D: [Touch: RHandTrigger], [Gamepad, LTouch, RTouch, Remote: None].
PrimaryIndexTriggerCurl
0x10
PrimaryIndexTriggerSlide
0x20
PrimaryThumbRestForce
0x40
PrimaryStylusForce
0x80
SecondaryIndexTriggerCurl
0x100
SecondaryIndexTriggerSlide
0x200
SecondaryThumbRestForce
0x400
SecondaryStylusForce
0x800
PrimaryIndexTriggerForce
0x1000
SecondaryIndexTriggerForce
0x2000
Any
~None
Maps to RawAxis1D: [Gamepad, Touch, LTouch, RTouch: Any], [Remote: None].

RawAxis1D Enum

Raw 1-dimensional axis (float) mappings that can be used to directly query the state of a controller.

Enumeration Constants

MemberValueDescription
None
0
Maps to Physical Axis1D: [Gamepad, Touch, LTouch, RTouch, Remote: None].
LIndexTrigger
0x01
Maps to Physical Axis1D: [Gamepad, Touch, LTouch: LIndexTrigger], [RTouch, Remote: None].
LHandTrigger
0x04
Maps to Physical Axis1D: [Touch, LTouch: LHandTrigger], [Gamepad, RTouch, Remote: None].
RIndexTrigger
0x02
Maps to Physical Axis1D: [Gamepad, Touch, RTouch: RIndexTrigger], [LTouch, Remote: None].
RHandTrigger
0x08
Maps to Physical Axis1D: [Touch, RTouch: RHandTrigger], [Gamepad, LTouch, Remote: None].
LIndexTriggerCurl
0x10
LIndexTriggerSlide
0x20
LThumbRestForce
0x40
LStylusForce
0x80
RIndexTriggerCurl
0x100
RIndexTriggerSlide
0x200
RThumbRestForce
0x400
RStylusForce
0x800
LIndexTriggerForce
0x1000
RIndexTriggerForce
0x2000
Any
~None
Maps to Physical Axis1D: [Gamepad, Touch, LTouch, RTouch: Any], [Remote: None].

Axis2D Enum

Virtual 2-dimensional axis (Vector2) mappings that allow the same input bindings to work across different controllers.

Enumeration Constants

MemberValueDescription
None
0
Maps to RawAxis2D: [Gamepad, Touch, LTouch, RTouch, Remote: None].
PrimaryThumbstick
0x01
Maps to RawAxis2D: [Gamepad, Touch, LTouch: LThumbstick], [RTouch: RThumbstick], [Remote: None].
PrimaryTouchpad
0x04
Maps to RawAxis2D: [Gamepad, Touch, LTouch, RTouch, Remote: None].
SecondaryThumbstick
0x02
Maps to RawAxis2D: [Gamepad, Touch: RThumbstick], [LTouch, RTouch, Remote: None].
SecondaryTouchpad
0x08
Maps to RawAxis2D: [Gamepad, Touch, LTouch, RTouch, Remote: None].
Any
~None
Maps to RawAxis2D: [Gamepad, Touch, LTouch, RTouch: Any], [Remote: None].

RawAxis2D Enum

Raw 2-dimensional axis (Vector2) mappings that can be used to directly query the state of a controller.

Enumeration Constants

MemberValueDescription
None
0
Maps to Physical Axis2D: [Gamepad, Touch, LTouch, RTouch, Remote: None].
LThumbstick
0x01
Maps to Physical Axis2D: [Gamepad, Touch, LTouch: LThumbstick], [RTouch, Remote: None].
LTouchpad
0x04
Maps to Physical Axis2D: [Gamepad, Touch, LTouch, RTouch, Remote: None].
RThumbstick
0x02
Maps to Physical Axis2D: [Gamepad, Touch, RTouch: RThumbstick], [LTouch, Remote: None].
RTouchpad
0x08
Maps to Physical Axis2D: [Gamepad, Touch, LTouch, RTouch, Remote: None].
Any
~None
Maps to Physical Axis2D: [Gamepad, Touch, LTouch, RTouch: Any], [Remote: None].

OpenVRButton Enum

OpenVR Controller State Enum.

Enumeration Constants

MemberValue
None
0
Two
0x0002
Thumbstick
0x100000000
Grip
0x0004

Controller Enum

Identifies a controller which can be used to query the virtual or raw input state.

Enumeration Constants

MemberValueDescription
None
OVRPlugin.Controller.None
Null controller.
LTouch
OVRPlugin.Controller.LTouch
Left Oculus Touch controller. Virtual input mapping differs from the combined L/R Touch mapping.
RTouch
OVRPlugin.Controller.RTouch
Right Oculus Touch controller. Virtual input mapping differs from the combined L/R Touch mapping.
Touch
OVRPlugin.Controller.Touch
Combined Left/Right pair of Oculus Touch controllers.
Remote
OVRPlugin.Controller.Remote
Oculus Remote controller.
Gamepad
OVRPlugin.Controller.Gamepad
Xbox 360 or Xbox One gamepad on PC. Generic gamepad on Android.
Hands
OVRPlugin.Controller.Hands
Left Hand provided by hand-tracking.
LHand
OVRPlugin.Controller.LHand
Left Hand provided by hand-tracking.
RHand
OVRPlugin.Controller.RHand
Right Hand provided by hand-tracking.
Active
OVRPlugin.Controller.Active
Default controller. Represents the controller that most recently registered a button press from the user.
All
OVRPlugin.Controller.All
Represents the logical OR of all controllers.

Handedness Enum

Enumeration Constants

MemberValue
Unsupported
OVRPlugin.Handedness.Unsupported
LeftHanded
OVRPlugin.Handedness.LeftHanded
RightHanded
OVRPlugin.Handedness.RightHanded

HapticsLocation Enum

Enumeration Constants

MemberValue
None
OVRPlugin.HapticsLocation.None
Hand
OVRPlugin.HapticsLocation.Hand
Thumb
OVRPlugin.HapticsLocation.Thumb
Index
OVRPlugin.HapticsLocation.Index

InteractionProfile Enum

Enumeration Constants

MemberValue
None
OVRPlugin.InteractionProfile.None
Touch
OVRPlugin.InteractionProfile.Touch
TouchPro
OVRPlugin.InteractionProfile.TouchPro
TouchPlus
OVRPlugin.InteractionProfile.TouchPlus

Hand Enum

Enumeration Constants

MemberValue
None
OVRPlugin.Hand.None
HandLeft
OVRPlugin.Hand.HandLeft
HandRight
OVRPlugin.Hand.HandRight

InputDeviceShowState Enum

Enumeration Constants

Member
Always
ControllerInHandOrNoHand
ControllerInHand
ControllerNotInHand
NoHand

ControllerInHandState Enum

Enumeration Constants

Member
NoHand
ControllerInHand
ControllerNotInHand

OpenVRController Enum

OpenVR Controller Enum.

Enumeration Constants

MemberValue
Unknown
0
OculusTouch
1
ViveController
2
WindowsMRController
3
Nav Logo
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
English (US)
© 2026 Meta