Interface IXRInputButtonReader
Interface which allows for callers to read the button's state from an input source.
Inherited Members
Namespace: UnityEngine.XR.Interaction.Toolkit.Inputs.Readers
Assembly: Unity.XR.Interaction.Toolkit.dll
Syntax
public interface IXRInputButtonReader : IXRInputValueReader<float>, IXRInputValueReaderMethods
ReadIsPerformed()
Read whether the button is currently performed, which typically means whether the button is being pressed. This is typically true for multiple frames.
Declaration
bool ReadIsPerformed()Returns
| Type | Description |
|---|---|
| bool | Returns true if the button is performed. Otherwise, returns false. |
Remarks
For input actions, this depends directly on the interaction(s) driving the action (including the default interaction if no specific interaction has been added to the action or binding).
See Also
ReadWasCompletedThisFrame()
Read whether the button completed this frame, which typically means whether the button stopped being pressed during this frame. This is typically only true for one single frame.
Declaration
bool ReadWasCompletedThisFrame()Returns
| Type | Description |
|---|---|
| bool | Returns true if the button completed this frame. Otherwise, returns false. |
Remarks
For input actions, this depends directly on the interaction(s) driving the action (including the default interaction if no specific interaction has been added to the action or binding).
See Also
ReadWasPerformedThisFrame()
Read whether the button performed this frame, which typically means whether the button started being pressed during this frame. This is typically only true for one single frame.
Declaration
bool ReadWasPerformedThisFrame()Returns
| Type | Description |
|---|---|
| bool | Returns true if the button performed this frame. Otherwise, returns false. |
Remarks
For input actions, this depends directly on the interaction(s) driving the action (including the default interaction if no specific interaction has been added to the action or binding).