UxrUnityXRControllerInput.GetInput2D Method

Gets the state of a 2D input element (joystick, touchpad…).

Namespace: UltimateXR.Devices.Integrations
Assembly: UltimateXR (in UltimateXR.dll) Version: 0.0.0.0

Syntax

C#

public override Vector2 GetInput2D(
	UxrHandSide handSide,
	UxrInput2D input2D,
	bool getIgnoredInput = false
)

Parameters

handSide

Type: UltimateXR.Core.UxrHandSide
Which controller to get input from. In Single devices where IsHandednessSupported is false, such as in gamepads, both hands will address the single device.

input2D

Type: UltimateXR.Devices.UxrInput2D
Element to get the input from

getIgnoredInput (Optional)

Type: System.Boolean
Whether to return ignored input by [!:SetIgnoreControllerInput]

Return Value

Type: Vector2
Vector2 telling the state of the controller element. Each component between [-1.0, 1.0]

Implements

IUxrControllerInput.GetInput2D(UxrHandSide, UxrInput2D, Boolean)

See Also

Reference

UxrUnityXRControllerInput Class
UltimateXR.Devices.Integrations Namespace